Skip to content

Latest commit

 

History

History
1172 lines (839 loc) · 26.4 KB

training.md

File metadata and controls

1172 lines (839 loc) · 26.4 KB
Raw

Git-GitHub-Training

ここでは以下をハンズオン形式で行います

  • 基本的な Git＆GitHub 操作
  • Git&GitHub を用いた「issue -> branch -> add -> commit -> push、pull request -> merge」の開発フロー
  • コンフリクトの解消

Git

基本的な git 操作(add,commit,etc)を行います

準備

ディレクトリ作成と遷移

これから本演習を行うため任意のディレクトリでワークツリー用のディレクトリを作製し遷移しましょう

$ mkdir git-practice
$ cd git-practice/

Author の確認

今回は global で設定します(プロジェクト毎に設定したい場合は local で設定しましょう)初めての場合は以下のエラーがでます。

$ git config --global --list
fatal: unable to read config file ‘/Users/h-miura/.gitconfig’: No such file or directory

設定(自身の user.name、user.email に置き換えましょう)

$ git config --global user.name hironomiu
$ git config --global user.email hironomiu@gmail.com
$ git config --global --list
user.name=hironomiu
user.email=hironomiu@gmail.com

デフォルトブランチの設定

デフォルトブランチをmainで設定しましょう

$ git config --global init.defaultBranch main

参考：次のgit initでmainの設定を行っていない場合以下のメッセージが出力されます

$ git init
hint: Using 'master' as the name for the initial branch. This default branch name
hint: is subject to change. To configure the initial branch name to use in all
hint: of your new repositories, which will suppress this warning, call:
hint:
hint: 	git config --global init.defaultBranch <name>
hint:
hint: Names commonly chosen instead of 'master' are 'main', 'trunk' and
hint: 'development'. The just-created branch can be renamed via this command:
hint:
hint: 	git branch -m <name>

Git 操作

init

init(初期化)によるローカルリポジトリの作製(ワークツリーの作製)

$ git init
Initialized empty Git repository in /xxxx/git-practice/.git/

branch の確認(何も表示されない。バージョンによっては* masterが表示されることがある)

$ git branch

.gitignore

トラッキングの対象外の設定(.gitignoreの作成)

$ touch .gitignore
$ ls .gitignore
.gitignore

gibo を用いたトラッキングの対象外の設定(.gitignoreの作成)。Mac の場合brew install giboでインストールでできる

$ gibo dump macOS >> .gitignore

gitignore.ioを使った.gitignoreの設定方法もあります

オペレーション

ここらからは開発想定として Markdown ファイルを作成編集し、それを git 管理(add,commi)していきます

ワークツリーで README.md ファイルの作成と編集

$ vi README.md
$ cat README.md
# git-practice

ステータス確認 .gitignore``README.mdがインデックス対象となっていること

$ git status
On branch main

No commits yet

Untracked files:
  (use "git add <file>..." to include in what will be committed)
	.gitignore
	README.md

nothing added to commit but untracked files present (use "git add" to track)

add(インデックスに登録)

$ git add README.md
$ git add .gitignore

ステータス確認 .gitignore``README.mdがコミット対象となっていること

$ git status
On branch main

No commits yet

Changes to be committed:
  (use "git rm --cached <file>..." to unstage)
	new file:   .gitignore
	new file:   README.md

コミット(commit)でローカルリポジトリに記録。-mでコミットメッセージを記載しましょう

$ git commit -m "created .gitignore README.md"
[main (root-commit) fc9aa86] created .gitignore README.md
 2 files changed, 31 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md

ブランチの確認

$ git branch
* main

ステータス確認

$ git status
On branch main
nothing to commit, working tree clean

ログの確認

$ git log
commit fc9aa867672f8bf471269849487933d15e92c81b (HEAD -> main)
Author: hironomiu <hironomiu@gmail.com>
Date:   Wed Nov 25 14:31:24 2020 +0900

    created .gitignore README.md

Author,Commiter を確認

$ git log --pretty=fuller
commit fc9aa867672f8bf471269849487933d15e92c81b (HEAD -> main)
Author:     hironomiu <hironomiu@gmail.com>
AuthorDate: Wed Nov 25 14:31:24 2020 +0900
Commit:     hironomiu <hironomiu@gmail.com>
CommitDate: Wed Nov 25 14:31:24 2020 +0900

    created .gitignore README.md

オペレーション

ここでは開発想定で README.md を編集し、それをインデックスを行う前で作業内容の取り消しを行います

README.md の末行にhogefugapiyoの追記

$ vi README.md
$ cat README.md
# git-practice
hogefugapiyo

git diffで追記したREADME.mdとの差分を確認する

$ git diff README.md
diff --git a/README.md b/README.md
index 3e4b5a2..4d69739 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,2 @@
 # git-practice
+hogefugapiyo

ステータスの確認

$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   README.md

no changes added to commit (use "git add" and/or "git commit -a")

ワーキングディレクトリ内の変更の取り消し(インデックス前の取り消し)

$ git restore README.md

追記した内容以前に戻っていること

$ cat README.md
# git-practice

ステータス確認

$ git status
On branch main
nothing to commit, working tree clean

オペレーション

ここでは開発想定で README.md を編集し、それをインデックス後(add)作業内容をインデックス前の状態に戻します

README.md の末行にpiyofugahogeの追記

$ vi README.md
$ cat README.md
# git-practice
piyofugahoge

ステータス確認

$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   README.md

no changes added to commit (use "git add" and/or "git commit -a")

git diffで追記したREADME.mdとの差分を確認する

$ git diff README.md
diff --git a/README.md b/README.md
index 3e4b5a2..2565824 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,2 @@
 # git-practice
+piyofugahoge

add でインデックスに登録する(git add .の.はカレントディレクトリ全てを指定する意味)

$ git add .

ステータス確認

$ git status
On branch main
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	modified:   README.md

差分の確認(何も返らない)

$ git diff README.md

インデックスの登録を取り消す

$ git restore --staged README.md

ステータス確認

$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   README.md

no changes added to commit (use "git add" and/or "git commit -a")

差分の確認。README.md の末行にpiyofugahogeの追記が存在すること

$ git diff README.md
diff --git a/README.md b/README.md
index 3e4b5a2..2565824 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,2 @@
 # git-practice
+piyofugahoge

ファイル確認(変更内容は残っている)

$ cat README.md
# git-practice
piyofugahoge

オペレーション

ここでは開発想定で README.md を編集し、それを commit 後、最新の commit ログをワーキングディレクトリの内容も取り消した状態に戻します

add(インデックス登録)

$ git add .

ステータス確認

$ git status
On branch main
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	modified:   README.md

コミット(commit)でローカルリポジトリに記録

$ git commit -m "modify README.md"
[main b85751a] modify README.md
 1 file changed, 1 insertion(+)

ステータス確認(add commitの対象が存在しないこと)

$ git status
On branch main
nothing to commit, working tree clean

これまでのコミットログの確認(ログは下から上で時系列に並ぶ)

$ git log
commit b85751a3f95a9abd5815174cd5b78aaf2c8cc487 (HEAD -> main)
Author: hironomiu <hironomiu@gmail.com>
Date:   Wed Nov 25 14:49:47 2020 +0900

    modify README.md

commit fc9aa867672f8bf471269849487933d15e92c81b
Author: hironomiu <hironomiu@gmail.com>
Date:   Wed Nov 25 14:31:24 2020 +0900

    created .gitignore README.md

現在の README.md の内容を確認

$ cat README.md
# git-practice
piyofugahoge

commit の取り消し(ワーキングディレクトリの内容も取り消し)

$ git reset --hard HEAD^
HEAD is now at fc9aa86 created .gitignore README.md

現在の README.md の内容を確認

$ cat README.md
# git-practice

コミットログからmodify README.mdのコミットログが取り消されていることを確認する(最新のコミットの取り消し)

$ git log
commit fc9aa867672f8bf471269849487933d15e92c81b (HEAD -> main)
Author: hironomiu <hironomiu@gmail.com>
Date:   Wed Nov 25 14:31:24 2020 +0900

    created .gitignore README.md

オペレーション

ここでは開発想定で README.md を編集し、それを commit 後、最新の commit ログを**取り消し(インデックスに戻す)更に取り消し(ワークツリーに戻す)更に取り消し(ワークツリーの内容を取り消した)**状態に戻します

README.md の末行にpiyofugahogeの追記

$ vi README.md
$ cat README.md
# git-practice
piyofugahoge

add(インデックス登録)

$ git add .

commit(ローカルリポジトリに記録)

$ git commit -m "modify README.md"
[main cedfb1d] modify README.md
 1 file changed, 1 insertion(+)

コミットログからmodify README.mdが追加されていることの確認

$ git log
commit cedfb1d94834035a034682d6514f797d2a57ebd4 (HEAD -> main)
Author: hironomiu <hironomiu@gmail.com>
Date:   Wed Nov 25 15:33:53 2020 +0900

    modify README.md

commit fc9aa867672f8bf471269849487933d15e92c81b
Author: hironomiu <hironomiu@gmail.com>
Date:   Wed Nov 25 14:31:24 2020 +0900

    created .gitignore README.md

commit の取り消し(インデックスに戻す)

$ git reset --soft HEAD^

ステータスからコミット(commit)対象にREADME.mdが存在することを確認

$ git status
On branch main
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	modified:   README.md

ファイル確認(変更内容は残っている)

$ cat README.md
# git-practice
piyofugahoge

インデックスの取り消し

$ git restore --staged README.md

ファイルの確認

$ cat README.md
# git-practice
piyofugahoge

ステータスからインデックス(add)対象にREADME.mdが存在することを確認

$ git status
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   README.md

no changes added to commit (use "git add" and/or "git commit -a")

README.md のワークツリー上の変更piyofugahogeの取り消し

$ git restore README.md

ステータス確認

$ git status
On branch main
nothing to commit, working tree clean

ファイル確認し末行にpiyofugahogeが存在しないこと

$ cat README.md
# git-practice

Git おさらい

インデックス

$ git add XX

コミット(-mでコミットメッセージを記載する)

$ git commmit -m "XXX"

差分の確認(様々な差分の確認方法があるので調べてみましょう)

$ git diff XX

状態の確認

$ git status

コミットログの確認

$ git log

GitHub

GitHub は SSH と HTTPS の 2 つのプロトコルが利用できます。SSH を利用する場合はssh-keygenを参考にすること

HTTPS を利用する場合はaccess-tokenを参考にすること

リポジトリの作成

ここまで Git の演習でローカルで作ったリポジトリをこれからの GitHub の演習用の pusu する先としてgit-practiceを作成しましょう

new-repo

Repository nameにgit-practiceを記載 -> Create repository を押下

new-repo2

ローカルでは事前にリポジトリを作成しているので…or push an existing repository from the command line内に記載された内容を全てローカルで実行しましょう(パスフレーズを要求されたら設定したパスフレーズを入力しましょう)

new-repo3

注：以下XXXは各自の GitHub アカウント名となる

$ git remote add origin git@github.com:XXX/git-practice.git
$ git branch -M main
$ git push -u origin main
Warning: Permanently added 'github.com,52.192.72.89' (RSA) to the list of known hosts.
Enumerating objects: 4, done.
Counting objects: 100% (4/4), done.
Delta compression using up to 4 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (4/4), 635 bytes | 635.00 KiB/s, done.
Total 4 (delta 0), reused 0 (delta 0), pack-reused 0
To github.com:XXX/git-practice.git
 * [new branch]      main -> main
Branch 'main' set up to track remote branch 'main' from 'origin'.

ブラウザをリロードして Git の演習で作成した内容が反映されていることを確認しましょう

new-repo4

開発サイクル

ここからは Git と GitHub を組み合わせ、「issue -> branch -> add -> commit -> push、pull request -> merge」までの開発フローを行っていきます

issue

GitHub の画面から

issues -> New issue 押下

issue

titleREADME編集Writefugahogepiyoを追記するを記載 -> Submit new issue 押下

issue2

issue が登録されていること#1はこの issue のパーマリンク。GitHub では様々なパーマリンックがあります

issue3

branch

ローカルリポジトリではデフォルトブランチの main で活動してることを確認しましょう。*のポインターが付いているブランチが現在作業しているブランチです

$ git branch
* main

issue に紐づく作業を行う branchmodify-readmeを作成しましょう

$ git branch modify-readme
$ git branch
* main
  modify-readme

作業する branch をmainからmodify-readmeに遷移しましょう

$ git switch modify-readme
Switched to branch 'modify-readme'

現在の作業 branch がmodify-readmeにポインタが指し示していることを確認しましょう

$ git branch
  main
* modify-readme

README.md 編集

issue に記載した作業内容を README.md に対して編集しましょう

$ vi README.md
$ cat README.md
# git-practice
fugahogepiyo

add&commit

ステータス確認

$ git status
On branch modify-readme
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   README.md

no changes added to commit (use "git add" and/or "git commit -a")

diff

$ git diff
diff --git a/README.md b/README.md
index 3e4b5a2..40551f9 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,2 @@
 # git-practice
+fugahogepiyo

add

$ git add .

commit(コミットメッセージに issue#1の作業であることを記載しましょう)

$ git commit -m "#1 modify README.md"
[modify-readme 8f20d8c] #1 modify README.md
 1 file changed, 1 insertion(+)

ステータス確認

$ git status
On branch modify-readme
nothing to commit, working tree clean

GitHub origin の確認

GitHub リポジトリ(今回はこちらが origin)を確認しましょう

注：XXXは各 GitHub ユーザが表示される

$ git remote -v
origin	git@github.com:XXX/git-practice.git (fetch)
origin	git@github.com:XXX/git-practice.git (push)

push

作成した modify-readme を GitHub リポジトリgit-practiceに push しましょう

$ git push origin modify-readme
Enter passphrase for key '/Users/miurahironori/.ssh/id_rsa':
Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Writing objects: 100% (3/3), 279 bytes | 139.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0)
remote:
remote: Create a pull request for 'modify-readme' on GitHub by visiting:
remote:      https://github.com/hironomiu/git-practice/pull/new/modify-readme
remote:
To github.com:hironomiu/git-practice.git
 * [new branch]      modify-readme -> modify-readme

GitHub 上で push された branch を確認しましょう

push

今会作成したmodify-readmeなどが表示されていることを確認しましょう

push2

pull request の作成と merge

GitHub の画面からPull requestタブを選択 -> New pull requestを押下(Compare & pull requestでも同様のことは可能)

pr

modify-readmeを選択 -> Create pull requestを押下

pr2

Writefixed #1を記載 -> Create pull requestを押下

pr3

Merge pull requestを押下(実際にはソースコードレビューを行った上で行う)

pr4

Confirm mergeを押下

pr5

Delete branchを押下(開発スタイルで残したい場合は不要)

pr6

Pull requestsタブを選択。pull request が存在しない(close されている)ことを確認

pr7

issuesタブを選択。issue が存在しない(close されている)ことを確認

pr8

<>Codeタブを選択README.mdにfugahogepiyoが記載されていること

pr9

ローカル取り込み(fetch & merge)

ここではリモート GitHub リポジトリの main からローカルの main に最新の取り込みを行います

branch の確認(このオペレーションではmodify-readmeが作業 branch としてさされている)

$ git branch
  main
* modify-readme

mainb に遷移する

$ git switch main
Switched to branch 'main'
Your branch is up to date with 'origin/main'.

branch の確認(mainを差していること)

$ git branch
* main
  modify-readme

リモート GitHub リポジトリの main の最新を fetch でローカルに取得する

$ git fetch origin main
Warning: Permanently added 'github.com,52.69.186.44' (RSA) to the list of known hosts.
remote: Enumerating objects: 1, done.
remote: Counting objects: 100% (1/1), done.
remote: Total 1 (delta 0), reused 0 (delta 0), pack-reused 0
Unpacking objects: 100% (1/1), 620 bytes | 620.00 KiB/s, done.
From github.com:hironomiu/git-practice
 * branch            main       -> FETCH_HEAD
   fc9aa86..6ee5cfa  main       -> origin/main

diff

$ git diff HEAD FETCH_HEAD
diff --git a/README.md b/README.md
index 3e4b5a2..40551f9 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,2 @@
 # git-practice
+fugahogepiyo

ローカルの main リポジトリにリモートリポジトリから取得した FETCH_HEAD を merge で取り込みましょう

$ git merge FETCH_HEAD
Updating fc9aa86..6ee5cfa
Fast-forward
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff(何もないので同じ状態)

$ git diff HEAD FETCH_HEAD

確認(リモートリポジトリの内容fugahogepiyoが取り込まれていることを確認)

$ cat README.md
# git-practice
fugahogepiyo

今回はリモートリポジトリから fetch->merge でローカルリポジトリの main に最新を取り込んだが、ローカルで別 branch で開発した内容は直接 main に merge することも可能です

CONFLICT の解消

ここでは CONFLICT を発生させ解決していきます。ここまで行ったローカルリポジトリ(ターミナル 1 と呼ぶ)と別でもう一つローカルリポジトリを作成(cloneにて、ターミナル 2 と呼ぶ)しオペレーションは行っていきます。

clone

GitHub リポジトリ -> Codeプルダウン -> SSHタブ選択 -> クリップボードにコピー

clone

ここまでのローカルリポジトリのディレクトリとは別ターミナル(ターミナル２)を用意し、任意の別ディレクトリでクリップボードにコピーした内容をgit clone のあとにペーストし実行しましょう

注：XXXはコピーした自分の GitHub アカウント名が入る

$ git clone git@github.com:XXX/git-practice.git
Cloning into 'git-practice'...
Enter passphrase for key '/Users/miurahironori/.ssh/id_rsa':
remote: Enumerating objects: 19, done.
remote: Counting objects: 100% (19/19), done.
remote: Compressing objects: 100% (8/8), done.
remote: Total 19 (delta 4), reused 17 (delta 3), pack-reused 0
Receiving objects: 100% (19/19), done.
Resolving deltas: 100% (4/4), done.

ディレクトリ遷移

$ cd git-practice

ターミナル 1(最初のリポジトリ)で作業

firstbranch の作成と遷移、確認(firstを指し示していること)

$ git branch first
$ git switch first
Switched to branch 'first'
$ git branch
* first
  main
  modify-readme

README.md の末行にfirstの追記編集

$ vi README.md
$ cat README.md
# git-practice
fugahogepiyo
first

add と commit

$ git add .
$ git commit -m "first"
[first b103e8d] first
 1 file changed, 1 insertion(+)

GitHub リポジトリにfirstbranch を push

# git push origin first
Warning: Permanently added 'github.com,13.114.40.48' (RSA) to the list of known hosts.
Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Delta compression using up to 4 threads
Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 302 bytes | 302.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
remote:
remote: Create a pull request for 'first' on GitHub by visiting:
remote:      https://github.com/hironomiu/git-practice/pull/new/first
remote:
To github.com:hironomiu/git-practice.git
 * [new branch]      first -> first

branches タブを選択しfirstbranch が存在することを確認

branch

ターミナル 2(新しいリポジトリ)で作業

secondbranch の作成と遷移、確認(secondを指し示していること)

$ git branch second
$ git switch second
Switched to branch 'second'
$ git branch
  main
* second

README.md の末行にsecondの追記編集

$ vi README.md
$ cat README.md
# git-practice
fugahogepiyo
second

add と commit

$ git add .
$ git commit -m "second"
[second 8534bb0] second
 1 file changed, 1 insertion(+)

GitHub リポジトリにsecondbranch を push

$ git push origin second
Warning: Permanently added 'github.com,13.114.40.48' (RSA) to the list of known hosts.
Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Delta compression using up to 4 threads
Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 303 bytes | 303.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
To github.com:hironomiu/git-practice.git
   6ee5cfa..8534bb0  second -> second

branches タブを選択しsecondbranch が存在することを確認

branch2

ターミナル 1、pull request の作成と merge

GitHub の画面からPull requestsタブ -> New pull requestを押下

pr-a

firstbranch を選択 -> Create pull requestを押下

pr-a2

Writefirstを記載 -> Create pull requestを押下

pr-a3

Confirm mergeを押下

pr-a4

Delete branchは省略する

ターミナル 2、pull request の作成と merge

GitHub の画面からPull requestsタブ -> New pull requestを押下

pr-a

secondbranch を選択 -> Create pull requestを押下

pr-b2

Writesecondを記載 -> Create pull requestを押下

pr-b3

conflict が発生していることを確認

pr-b4

ターミナル 2 でコンフリクトの解消

リモートリポジトリの main の最新を fetch

$ git fetch origin main

branch の確認(secondであること)

$ git branch
  main
* second

secondbranch に FETCH_HEAD を merge で取り込む

$ git merge FETCH_HEAD
Auto-merging README.md
CONFLICT (content): Merge conflict in README.md
Automatic merge failed; fix conflicts and then commit the result.

コンフリクトの内容を確認

$ cat README.md
# git-practice
fugahogepiyo
<<<<<<< HEAD
second
=======
first
>>>>>>> 7b868e363d289674d599834ca25fc0517cda97fe

CONFLICT を解消(今回は末行にsecond,firstの順で編集、実際のコンフリクトはあるべき姿に編集する)

$ vi README.md
$ cat README.md
# git-practice
fugahogepiyo
second
first

add&commit

$ git add .
$ git commit -m "CONFLICTの修正"
[second a1807fb] CONFLICTの修正

リモートリポジトリにsecondbranch の最新 commit を push

$ git push origin second
Warning: Permanently added 'github.com,52.69.186.44' (RSA) to the list of known hosts.
Enumerating objects: 7, done.
Counting objects: 100% (7/7), done.
Delta compression using up to 4 threads
Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 368 bytes | 368.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
To github.com:hironomiu/git-practice.git
   8534bb0..a1807fb  second -> second

GitHub のPull reqestsタブ画面でグリーンになっていることを確認しMerge pull requestを押下

pr-b5

Confirm mergeを押下

pr-b6

Delete branch は省略<>Codeタブ、README.mdにsecond firstの記述が追加されていること

pr-b7

ここまででコンフリクトの解消は完了です