いい加減なGitHubチュートリアル

しがない理工系学生による超大雑把なGitの使い方

Transcript

1. いい加減なGutHubチュートリアル @R.Miyamoto
2. <注意> 「Git」の簡単な使い方しか説明しません 詳しいシステムの動作や用語は各自で調べてください 導入方法や設定は2017/01/20時点での方法です 分からないところや、おかしなところは以下に連絡してください @R.Miyamoto : kirue129.develop@gmail.com
3. ソースコードをインターネットで管理してくれるサイト GitHubとは？ 「Git」というバージョン管理ソフトをネット上で行うサービス 作業履歴が残り、変更箇所が分かりやすい 共同作業時のマージを上手いことしてくれる 事前に「GitHub」でのアカウント登録や「Git」のインストールが必要
4. 目次 1. 「GitHub」でのアカウント登録 2. 「Git」のインストール 3. 「Git」の初期設定 4. ソースコードの管理方法 a. リポジトリの作成 b. ソースコードの編集 c. ブランチの切り替え d. 複数人での管理
5. 「GitHub」でのアカウント登録
6. アカウント登録 -「GitHub」でのアカウント登録- ブラウザで公式サイトを開く 「GitHub」で検索して公式サイトにアクセス ユーザー情報の記入 上段 : ユーザー名 中段 : メールアドレス 下段 : パスワード（数字を一文字でも含める） ユーザー名 メールアドレス パスワード
7. アカウント登録 -「GitHub」でのアカウント登録- ユーザーの種類の選択 「Unlimited public repositories for free.」が 選択されているのを確認して「Continue」 メール認証 登録したメールアドレスの受信Box内のリンクから 「GitHub」に飛ぶことで認証完了
8. 「Git」のインストール
9. インストーラーの入手 -「Git」のインストール- ブラウザで公式サイトを開く 「Git」で検索して「Git - Official Site」にアクセス 自分の環境にあったインストーラーをダウンロード サイト内の「Downloads」をクリックし、 自分の環境にあったもの（大体の人は「Windows」）を クリックするとインストーラーがダウンロードされる
10. 「Git」の導入 -「Git」のインストール- インストーラーの実行 先ほどダウンロードしたファイルをダブルクリックで実行 特に気にしないで、「Next」or「install」をクリックしてインストール インストール先の変更やオプション変更はしなくておｋ 「Git Bush」の起動確認 スタートメニュー > すべてのプログラム > Git > Git Bashを起動
11. 「Git」の初期設定
12. 名前、メール等の設定 -「GitHub」の初期設定- ユーザー情報の入力 「GitHub」上のユーザー名、メールアドレスを入力 色の指定 $ git config --global user.name "[ユーザー名]" $ git config --global user.email [メールアドレス] $ git config --global color.ui true 現在の設定の確認（任意） $ git config --list 日本語への対応（※） $ git config --global core.quotepath off ※ファイル名が日本語にならない場合は、再インストール　 すると治るかもしれません（たぶん）
13. 「GitHub」とクライアントのssh接続 -「GitHub」の初期設定- ssh公開鍵の生成 鍵用のフォルダを作り、その中で公開鍵を作成 $ mkdir .ssh $ cd .ssh $ ssh-keygen Enter passphraseと表示され、 パスフレーズの入力（※）を2回求められるので 同じパスフレーズを入力する。 すると左のような画面になり鍵が生成される （鍵の型は毎回異なるので同じ物になりません） ※パスフレーズは入力せず Enterだけでも構いません
14. 「GitHub」とクライアントのssh接続 -「GitHub」の初期設定- ssh公開鍵の確認とコピー 公開鍵を確認し内容をコピー（※） $ cat ~/.ssh/id_rsa.pub ※コピーは右クリックやコマンドから行ってください 鍵の中身は英数字の羅列になっており、環境によって変わります
15. 「GitHub」とクライアントのssh接続 -「GitHub」の初期設定- 「GitHub」の公開鍵の登録画面を開く ログインして以下の順に進み、鍵の登録画面を開く →「Setting」 （アイコンクリック時にメニューとして表示される） →「SHH and GPS keys」 →「New SSH key」 公開鍵の登録 以下の二つを入力して「Add key」をクリック 「Title」 今使っているマシンの名前を書く（Win10MainPCとか） 「Key」 先ほどコピーした鍵の中身を貼り付け クライアント名 先ほどコピーした公開鍵の中身
16. 「GitHub」とクライアントのssh接続 -「GitHub」の初期設定- 接続の確認 「Git Bush」上で接続の確認を行う $ ssh -T git@github.com 以下の文面が返ってきたら接続完了 Hi (account名)! You've successfully authenticated, but GitHub does not provide shell access. ※ssh初回接続だと「Are you sure you want to continue connecting (yes/no)?」と聞かれるが、「yes」と入力すればおｋ
17. ソースコードの管理方法
18. リポジトリについて -ソースコードの管理方法- リポジトリとは？ ファイルやディレクトリの状態を記録する場所 履歴が残るため、初期から最新までのバージョンをフォルダ管理する必要がない リモートリポジトリとローカルリポジトリ 「Git」のリポジトリはリモートリポジトリとローカルリポジトリに分けられる ・リモートリポジトリ 専用のサーバに配置して複数人で共有するためのリポジトリ ・ローカルリポジトリ ユーザ一人ひとりが利用するために、自分の手元のマシン上に配置するリポジトリ
19. リポジトリについて -ソースコードの管理方法- リポジトリの作成 自分の手元にローカルリポジトリを作成する方法は二種類 <1>全く新しいリポジトリを作成する <2>リモートリポジトリをコピーして作成する 今回は以下のように解説する 「a.リポジトリの作成」 ・・・・・・全く新しいリポジトリを作成する方法 「d.複数人での管理」 ・・・・・・リモートリポジトリをコピーして作成する方法
20. リポジトリの作成
21. リモートリポジトリの作成 -リポジトリの作成- 新規リポジトリ作成画面の表示 ログインして「New repository」をクリック リポジトリの作成 「Repository name」にプロジェクト名を入力 （プロジェクト名は英名にすること） 入力後は「Create repository」をクリック →この時、移動したページを開いたままに 　しておくこと プロジェクト名
22. ローカルリポジトリの作成 -リポジトリの作成- リポジトリを保管するディレクトリの作成 「Git Bush」上で以下のコマンドを実行 $ mkdir [リポジトリ名(プロジェクト名)] $ cd [リポジトリ名(プロジェクト名)]
23. ローカルリポジトリの作成 -リポジトリの作成- ローカル上にリポジトリの作成 「Git Bush」上で移動したページの左の囲っている部分を そのまま「Git Bush」にコピペする この部分を「Git Bush」にコピペす る
24. リモートリポジトリへ反映 -リポジトリの作成- 「Git Bush」上でのログイン 先ほどのコマンドをすべて実行すると、ウィンドウが出るので、 「GitHub」のアカウントでログイン ユーザー名 パスワード
25. リモートリポジトリの確認 -リポジトリの作成- 「GitHub」上で確認 「Your profile」→「[リポジトリ名]」で作成されたか確認
26. ソースコードの編集
27. ファイルの追加 -ソースコードの編集- ファイルの追加 先ほど作成したリポジトリ上で適当に「test.txt」を作成し、 ファイルの中身を「git test」としておく
28. ローカルリポジトリにファイルを登録 -ソースコードの編集- ファイルの登録 「Git Bush」上でファイルの登録を行う $ git add -A この時、「warning: LF will be replaced by CRLF in …」 と出た場合、以下のコマンド(※)を実行し、再登録をする $ git config --global core.autoCRLF false $ git add -A ※Git が改行コードを CRLF へ変更しようとするのでそれをやめさせ る
29. ローカルリポジトリのファイルを確認 -ソースコードの編集- ファイルの確認 追加されたファイルがリポジトリに反映されているかチェック $ git status 上の画面より、追加されていることが確認できる
30. ローカルリポジトリの更新（コミット） -ソースコードの編集- ローカルリポジトリの更新（コミット） コミットコマンドを実行してリポジトリの更新を行う コメント（※）は適当に「commit test」とでもしておく $ git commit -m "[コメント]" ローカルリポジトリの更新の確認 先ほどコミットした内容が反映されているかチェック $ git log ※このコメントがかなり重要で、本来「 ◦◦する処理の追加」などと書く必要がある 　これがあるおかげで、 GitHubでソースの変更箇所とその理由が一目でわかる 　あと今回は英語だが、日本語ので書いてもよい
31. リモートリポジトリにプッシュ -ソースコードの編集- リモートリポジトリにアップロード プッシュ（※）を実行してリモートリポジトリの更新を行う 「ブランチ名」（後で解説します）は今回「master」です $ git push origin [ブランチ名] ※本来プッシュする場合は、他人の更新と混在しないように、一度リモートのデータを持ってくるのですが、 　今回は一人で作業者していると仮定して、そこを省略しています。 　複数人での編集については「複数人での管理」を参照してください。
32. リモートリポジトリで確認 -ソースコードの編集- リモートリポジトリの状態を確認 「GitHub」上で今回作成したリポジトリを見てみるとファイルが 追加されているのが確認できます。 ファイルが追加されている
33. ブランチの切り替え
34. ブランチについて -ブランチの切り替え- ブランチとは • 履歴の流れを分岐して記録していくためのもの • 分岐したブランチは他のブランチの影響を受けない →同リポジトリ中で複数の変更を同時に進めていくことができる！ A B C O X リリース版の履歴 新機能の追加 バグの修正 Bでブランチを生成することで、同時に複数の作業 (C,O,X)をそれぞれ行うことができる ちなみに、リポジトリを作成した際のブランチを「 master」といって、今回でいう A-B-Cがそれにあたる
35. マージについて -ブランチの切り替え- マージとは • ブランチを合流（統合）すること →ブランチ内での作業が終了した際、他のブランチ(masteとか)に反映させる Y リリース版の履歴 バグの修正 新機能の追加 D C O X E F D.Eでマージすることで、複数の作業 (C+O,D+Y)をそれぞれ合わせることができます
36. ブランチの生成 -ブランチの切り替え- ブランチの確認 ブランチ一覧を表示して現在のブランチ名を確認する（※1） $ git branch ブランチの生成 ブランチ名を半角英数字（数字のみは不可）で入力し生成 今回は適当に「test」（※2）としておく $ git branch [ブランチ名] ※1.実はここに現在のブランチ名が記述されている ブランチの再確認 ブランチ一覧から新規ブランチが生成されているか確認 $ git branch ※2.本来は作業概要（add_ReadBackSensor等）を書く
37. ブランチの切り替え -ブランチの切り替え- ブランチの切り替え 切り替えるブランチ（ここでは「test」）を指定して実行します $ git checkout [ブランチ名] ブランチの再確認 ブランチ一覧からブランチが切り替わっているか確認 $ git branch
38. ファイルの編集 -ブランチの切り替え- ファイルの編集 ファイル「text.txt」を適当に書き換える ファイルのcommitとpush 変更したファイルをリモートリポジトリにpush 今回は以下のようにする [コメント]・・・・・・ブランチの切り替えテスト [ブランチ名]・・・test $ git add -A $ git commit -m “[コメント]” $ git push origin [ブランチ名]
39. リモートリポジトリで確認 -ブランチの切り替え- リモートリポジトリの状態を確認 「GitHub」上で今回作成したリポジトリを見てみるとそのブラン チ上でしかファイルが編集されているのが確認できます。 生成されたブランチへ切り替 え 「test」ブランチのみでしか編集がされていないのがわかる
40. マスターブランチへマージ -ブランチの切り替え- マスターブランチに切り替え ブランチを「master」に切り替える $ git checkout master マスターブランチにマージ 「master」にマージしたいブランチを指定 今回ブランチ名は先ほど作成した「test」とする $ git merge [ブランチ名]
41. 不要なブランチの削除 -ブランチの切り替え- 不要なブランチの削除 マージしたブランチは不要のため消します ブランチ名は「test」です $ git branch -d [ブランチ名] 削除されたか確認 ブランチ一覧を表示しマージしたブランチが消えたことを確認 $ git branch
42. 「test」ブランチの編集が「master」にも 反映されているのが確認できる リモートリポジトリに反映 -ブランチの切り替え- リモートリポジトリに反映 マージした結果をリモート コメントは適当に、ブランチ名は「master」です $ git add -A $ git commit -m “[コメント]” $ git push origin [ブランチ名] リモートリポジトリの確認
43. 複数人での管理
44. Pull Requestについて -複数人での管理- Pull Requestとは • 機能追加や改修など、作業内容を レビュー・マージ担当者やその他関係者に通知。 • ソースコードの変更箇所をわかりやすく表示。 • ソースコードに関するコミュニケーションの場を提供。 →要は自分の作業内容を他人にレビューしてもらう機能
45. リポジトリのクローン -複数人での管理- コピーするリポジトリのURLを取得 コピーするURLを「Clone or Download」から取得 ローカルでリポジトリのクローン 先ほど取得したURLを以下のコマンドに入れて、ローカルにリポジトリをコピー $ git clone [リモートリポジトリの URL]
46. リポジトリの確認 -複数人での管理- リポジトリの確認 クローンに成功すると、リポジトリ名のフォルダが生成されているか確認し、 その内部もリモートリポジトリと同一であるかを確認する [リポジトリ名]・・・リモートリポジトリと同名 $ ls [リポジトリ名] $ cd [リポジトリ名] $ ls
47. リポジトリの編集 -複数人での管理- リポジトリの編集 前項”ブランチの切り替え”を参考にして以下のことを行う ・ブランチの切り替え (branch, checkout) ・ファイルの編集 (エディタで編集)
48. リモートリポジトリへのプッシュ -複数人での管理- リモートリポジトリへのプッシュ 前項”ブランチの切り替え”を参考にして以下のことを行う ・ファイルの登録 (add) ・ローカルリポジトリの更新 (commit) ・リモートリポジトリへアップロード (push)
49. Pull Requestを選択 -複数人での管理- Pull Requestを選択 自分のブランチをpushすると、「Pull request」が選択できる。
50. Pull Requestの生成 -複数人での管理- Pull Requestの生成 変更点の説明を入れて「Create pull request」 ソースの変更点の概要 ソースの変更点の説明
51. Pull Requestへのレビュー -複数人での管理- Pull Requestに対してコメント pushされて内容が問題ないか レビュアー レビュアーはコメントが書ける ここから変更箇所を確認できる リモートのマスターにマージ レビュアーはpushされた内容が 問題ないかチェックをする この時、修正があれば コメントを書く 内容に問題がなければ、 リモートのマスターへマージを行う
52. リモートリポジトリのマスターの確認 -複数人での管理- リモートリポジトリのマスターを確認 pushされて内容が問題ないか レビュアー リモートのマスターにマージ リモートリポジトリのマスターブランチに、 pushした内容が反映されているか確認
53. リモートでマージされた後にやること -複数人での管理- マスターブランチに切り替え マスターブランチに切り替える $ git checkout master リモートリポジトリの更新を取得 マスターの変更内容を取得する $ git pull
54. もっとGitを使いこなすには • 以下のコマンドが使えるようになろう ◦ diff（差分の比較） ◦ fetch（ローカルリポジトリの更新）etc… • マージ時の競合の対処法をしろう（そのうち書くかも・・・） • .gitignoreで除外ファイルの設定しよう
55. 参考文献 1. GitHubの初期設定（SSH接続からリポジトリへのpushまで） http://qiita.com/drapon/items/441e18452b25060d61f1 2. サルでもわかるGit入門 http://www.backlog.jp/git-guide/