高専プロコンのためのGit入門

高専競プロ鯖でのGitの勉強会用に作成したスライドです

Transcript

1. 高専プロコンのための Git 入門 ~ 競プロ鯖版 ~ 2025/04/29 宇部高専 4 年 Yukkku
2. 目標 • 高専プロコンの開発に Git を導入して幸せになろう 必要なもの • 簡単なコマンド操作の知識 • Git を使える環境 • GitHub のアカウント • Git を導入する意思
3. Git って? • バージョン管理システム
4. Git って? • バージョン管理システム • 簡単に言えば「変更履歴」のすごい版
5. Git って? • バージョン管理システム • 簡単に言えば「変更履歴」のすごい版 📄 資料.docx 📄 資料(1).docx 📄 資料 最終版(1).docx 📄 資料(2).docx 📄 資料 最終版 修正済.docx 📄 資料 提出用.docx
6. Git って? • バージョン管理システム • 簡単に言えば「変更履歴」のすごい版 📄 資料.docx 📄 資料(1).docx 📄 資料 最終版(1).docx 📄 資料(2).docx 📄 資料 最終版 修正済.docx 📄 資料 提出用.docx これをスタイリッシュにできる.
7. GitHub? • Git を使う上で便利なサービス
8. GitHub? • Git を使う上で便利なサービス • Git にはデータをサーバーと共有する機能がある
9. GitHub? • Git を使う上で便利なサービス • Git にはデータをサーバーと共有する機能がある ‣ バックアップのため ‣ 他の端末との中継 ‣ 単純に中央サーバーがあると便利じゃん?
10. GitHub? • Git を使う上で便利なサービス • Git にはデータをサーバーと共有する機能がある ‣ バックアップのため ‣ 他の端末との中継 ‣ 単純に中央サーバーがあると便利じゃん? GitHub はこれをするためのサーバーのサービス
11. GitHub? • Git を使う上で便利なサービス • Git にはデータをサーバーと共有する機能がある ‣ バックアップのため ‣ 他の端末との中継 ‣ 単純に中央サーバーがあると便利じゃん? GitHub はこれをするためのサーバーのサービス • その他, 開発に便利な機能が色々ある ‣ issue ‣ pull request
12. GitHub? • Git を使う上で便利なサービス • Git にはデータをサーバーと共有する機能がある ‣ バックアップのため ‣ 他の端末との中継 ‣ 単純に中央サーバーがあると便利じゃん? GitHub はこれをするためのサーバーのサービス • その他, 開発に便利な機能が色々ある ‣ issue ‣ pull request GitHub ではなく Git の入門なので, 今回は説明しない
13. セットアップ まず, Git が入ってるかチェック $ git --version git version 2.49.0 入ってなかった場合は, インストールしてください. (環境によってやることが違うのでインストール手順は略) 公式サイト: https://git-scm.com/
14. セットアップ アカウントのセットアップ. GitHub の登録情報と同じものを入れてね! $ git config --global user.name "Yukkku" $ git config --global user.email "foo.bar@example.com"
15. セットアップ アカウントのセットアップ. GitHub の登録情報と同じものを入れてね! $ git config --global user.name "Yukkku" $ git config --global user.email "foo.bar@example.com" 設定は以下のように確認できる. $ git config -l user.name=Yukkku user.email=foo.bar@example.com
16. セットアップ ssh 接続の設定をする
17. セットアップ ssh 接続の設定をする • GitHub とプログラムを非公開のまま通信するのに必要
18. セットアップ ssh 接続の設定をする • GitHub とプログラムを非公開のまま通信するのに必要 • 公開鍵暗号通信
19. セットアップ ssh 接続の設定をする • GitHub とプログラムを非公開のまま通信するのに必要 • 公開鍵暗号通信 ‣「公開鍵」を使って暗号化して「秘密鍵」で解読する
20. セットアップ ssh 接続の設定をする • GitHub とプログラムを非公開のまま通信するのに必要 • 公開鍵暗号通信 ‣「公開鍵」を使って暗号化して「秘密鍵」で解読する ‣ 公開鍵は公開しても良くて, 秘密鍵は公開したら通信内容がバレる
21. セットアップ ssh 接続の設定をする • GitHub とプログラムを非公開のまま通信するのに必要 • 公開鍵暗号通信 ‣「公開鍵」を使って暗号化して「秘密鍵」で解読する ‣ 公開鍵は公開しても良くて, 秘密鍵は公開したら通信内容がバレる ‣ 本筋ではないので細かい説明は略
22. セットアップ とりあえず以下を実行して, 秘密鍵/公開鍵を生成する $ ssh-keygen Generating public/private ed25519 key pair. Enter file in which to save the key (/(略)/.ssh/id_ed25519): ←とりあえず空欄にして Enter passphrase for "/(略)/.ssh/id_ed25519" (empty for no passphrase): ←パスワード Enter same passphrase again: ←パスワード(再入力) Your identification has been saved in /(略)/.ssh/id_ed25519 Your public key has been saved in /(略)/.ssh/id_ed25519.pub The key fingerprint is: (略)
23. セットアップ とりあえず以下を実行して, 秘密鍵/公開鍵を生成する $ ssh-keygen Generating public/private ed25519 key pair. Enter file in which to save the key (/(略)/.ssh/id_ed25519): ←とりあえず空欄にして Enter passphrase for "/(略)/.ssh/id_ed25519" (empty for no passphrase): ←パスワード Enter same passphrase again: ←パスワード(再入力) Your identification has been saved in /(略)/.ssh/id_ed25519 Your public key has been saved in /(略)/.ssh/id_ed25519.pub The key fingerprint is: (略) • /(略)/.ssh/id_ed25519 に秘密鍵がある • /(略)/.ssh/id_ed25519.pub に公開鍵がある
24. セットアップ GitHub の設定にアクセスして「New SSH key」から公開鍵を登録 https://github.com/settings/ssh
25. セットアップ GitHub の設定にアクセスして「New SSH key」から公開鍵を登録 https://github.com/settings/ssh • Title には端末の簡単な説明(「家のパソコン」とか) • Key type は Authentication Key を選択 • Key には公開鍵をコピペ
26. セットアップ GitHub の設定にアクセスして「New SSH key」から公開鍵を登録 https://github.com/settings/ssh • Title には端末の簡単な説明(「家のパソコン」とか) • Key type は Authentication Key を選択 • Key には公開鍵をコピペ 以下のように接続確認できる $ ssh -T git@github.com Enter passphrase for key '/(略)/.ssh/id_ed25519': ←パスワード入力 Hi Yukkku! You've successfully authenticated, but GitHub does not provide shell access.
27. はじめる プログラム非公開でチーム開発するなら Organization が要る
28. はじめる プログラム非公開でチーム開発するなら Organization が要る • Organization は「チームアカウント」っぽいやつ
29. はじめる プログラム非公開でチーム開発するなら Organization が要る • Organization は「チームアカウント」っぽいやつ • 個人アカウントで進めると他の人が編集できなくなってしまう
30. はじめる プログラム非公開でチーム開発するなら Organization が要る • Organization は「チームアカウント」っぽいやつ • 個人アカウントで進めると他の人が編集できなくなってしまう 必要なら↓から作ってください. 無料枠で十分です https://github.com/settings/organizations
31. はじめる そこら辺にある「New」からリポジトリを作る
32. はじめる そこら辺にある「New」からリポジトリを作る 設定はおまかせ
33. はじめる そこら辺にある「New」からリポジトリを作る 設定はおまかせ • Owner が Organization になってることを確認 • 競技部門なら確実に Private にしよう •「Add .gitignore」欄は分からないならとりあえず None に.
34. はじめる 端末から編集できるようにする $ git clone git@github.com:Yukkku/procon36-ube.git Cloning into 'procon36-ube'... Enter passphrase for key '/(略)/.ssh/id_ed25519': warning: You appear to have cloned an empty repository. # ディレクトリが作られたので, そこに移動 $ cd procon36-ube
35. Git を使う とりあえずプログラムを書いた $ cat main.cpp #include <print> int main() noexcept { std::println("Hello, World!"); return 0; } $ g++ -std=gnu++23 main.cpp $ ./a.out Hello, World! 「このプログラムを作った」という履歴を残すことを考える
36. コミット(commit)
37. コミット(commit) 履歴の最小単位
38. コミット(commit) 履歴の最小単位 • 誰が編集したか • いつ編集したか • どういう変更をしたか • 一言コメント (コミットメッセージ) が記録されている
39. コミット(commit) 履歴の最小単位 • 誰が編集したか • いつ編集したか • どういう変更をしたか • 一言コメント (コミットメッセージ) が記録されている 原則として作ったコミットはずっと残る
40. コミットを作る どの変更をコミットに記録するか指定する $ git add main.cpp # 一括指定もできる $ git add *.cpp
41. コミットを作る どの変更をコミットに記録するか指定する $ git add main.cpp # 一括指定もできる $ git add *.cpp • a.out みたいな実行ファイルは普通はコミットに記録しない
42. コミットを作る どの変更をコミットに記録するか指定する $ git add main.cpp # 一括指定もできる $ git add *.cpp • a.out みたいな実行ファイルは普通はコミットに記録しない git add を取り消したいときは git rm --cached git rm --cached main.cpp --cached が無いとファイルが消えます(一敗)
43. コミットを作る どのファイルを git add したかは git stauts で確認できる $ git status On branch main No commits yet Changes to be committed: (use "git rm --cached <file>..." to unstage) new file: main.cpp Untracked files: (use "git add <file>..." to include in what will be committed) a.out
44. コミットを作る 記録するファイルを指定し終えたら以下を実行 $ git commit
45. コミットを作る 記録するファイルを指定し終えたら以下を実行 $ git commit 実行するとエディタが開くので, 1 行目にコミットメッセージを入力
46. コミットを作る 記録するファイルを指定し終えたら以下を実行 $ git commit 実行するとエディタが開くので, 1 行目にコミットメッセージを入力 書き込んで保存して閉じるとコミットが作られる
47. コミットを作る 記録するファイルを指定し終えたら以下を実行 $ git commit 実行するとエディタが開くので, 1 行目にコミットメッセージを入力 書き込んで保存して閉じるとコミットが作られる コミットをやめたいときは空白のまま閉じるとよい
48. GitHub と同期する git push でコミットを GitHub に送れる $ git push Enter passphrase for key '/(略)/.ssh/id_ed25519': (略) To github.com:Yukkku/procon36-ube.git * [new branch] main -> main
49. GitHub と同期する git push でコミットを GitHub に送れる $ git push Enter passphrase for key '/(略)/.ssh/id_ed25519': (略) To github.com:Yukkku/procon36-ube.git * [new branch] main -> main GitHub にアクセスして, 反映されてることを確認する.
50. GitHub と同期する 逆に, GitHub 上のコミットを反映するには git pull を使う $ git pull Enter passphrase for key '/(略)/.ssh/id_ed25519': (略) From github.com:Yukkku/procon36-ube * [new branch] main -> origin/main # 反映されているか確認 $ ls main.cpp
51. GitHub と同期する 逆に, GitHub 上のコミットを反映するには git pull を使う $ git pull Enter passphrase for key '/(略)/.ssh/id_ed25519': (略) From github.com:Yukkku/procon36-ube * [new branch] main -> origin/main # 反映されているか確認 $ ls main.cpp push/pull はこまめにしましょう
52. .gitignore さっきの a.out みたいな「コミットしないファイル」を間違ってコミッ トしないようにできる設定ファイル
53. .gitignore さっきの a.out みたいな「コミットしないファイル」を間違ってコミッ トしないようにできる設定ファイル 例えば.gitignore に *.out *.exe みたいに書けば自動的に実行ファイルを無視するようになる
54. .gitignore さっきの a.out みたいな「コミットしないファイル」を間違ってコミッ トしないようにできる設定ファイル 例えば.gitignore に *.out *.exe みたいに書けば自動的に実行ファイルを無視するようになる 言語ごとに.gitignore のテンプレートみたいなのがあるので とりあえずコピペしておこう https://github.com/github/gitignore
55. ブランチ(branch) 📄 📄 📄 📄 編集 編集 編集 📄: Commit
56. ブランチ(branch) 📄 📄 📄 📄 編集 編集 編集 📄 📄 📄 編集 編集 編集 コミットの列は枝分かれできる
57. ブランチ(branch) 📄 📄 📄 📄 編集 編集 編集 📄 📄 📄 編集 編集 編集 コミットの列は枝分かれできる • ミスをしてやり直すとき • 試作とかしたいとき • 複数人が同時に編集したとき
58. ブランチ(branch) 📄 📄 📄 📄 編集 編集 編集 📄 📄 📄 編集 編集 編集 ◯◯実装 △△修正 枝はそれぞれ名前をつけて区別できる(ブランチ)
59. ブランチ(branch) 📄 📄 📄 📄 編集 編集 編集 📄 📄 📄 編集 編集 編集 ◯◯実装 △△修正 枝はそれぞれ名前をつけて区別できる(ブランチ) 名前を枝の最新のコミットと紐づけて枝を管理している
60. ブランチ(branch) 📄 📄 📄 📄 編集 編集 編集 📄 📄 📄 編集 編集 編集 📄 ◯◯実装 △△修正 他のブランチで行った変更を取り込むことができる(マージ)
61. ブランチ(branch) 📄 📄 📄 📄 編集 編集 編集 📄 📄 📄 編集 編集 編集 📄 ◯◯実装 △△修正 他のブランチで行った変更を取り込むことができる(マージ) 普通は自動で変更点を取り込めるが, 手動での調整が必要なときも
62. ブランチを使う git branch <ブランチ名> でブランチを作れる $ git branch sample-branch
63. ブランチを使う git branch <ブランチ名> でブランチを作れる $ git branch sample-branch ブランチの一覧は git branch で表示できる $ git branch * main sample-branch main は最初からあるブランチ (master って名前のときも)
64. ブランチを使う git branch <ブランチ名> でブランチを作れる $ git branch sample-branch ブランチの一覧は git branch で表示できる $ git branch * main sample-branch main は最初からあるブランチ (master って名前のときも) 📄 📄 main sample-branch
65. ブランチを使う 読み込むブランチを切り替えるには git checkout $ git checkout sample-branch # 現在読み込んでるブランチに*がついている $ git branch main * sample-branch
66. ブランチを使う 読み込むブランチを切り替えるには git checkout $ git checkout sample-branch # 現在読み込んでるブランチに*がついている $ git branch main * sample-branch sample-branch にコミットしてみる # (予めfizzbuzz.cppを用意) $ git add fizzbuzz.cpp $ git commit
67. ブランチを使う 現時点でこういう関係になっている 📄 📄 📄 main sample-branch
68. ブランチを使う 現時点でこういう関係になっている 📄 📄 📄 main sample-branch main は変更されてないので, 切り替えると fizzbuzz.cpp が無い $ git checkout main $ ls a.out main.cpp # sample-branchに戻ってくるとfizzbuzz.cppが復活する $ git checkout sample-branch $ ls a.out main.cpp fizzbuzz.cpp
69. ブランチを使う main ブランチの main.cpp を編集する $ git checkout main # (ここでmain.cppを編集する) $ git add main.cpp $ git commit
70. ブランチを使う main ブランチの main.cpp を編集する $ git checkout main # (ここでmain.cppを編集する) $ git add main.cpp $ git commit こういう状態になる 📄 📄 📄 📄 main sample-branch ←fizzbuzz.cpp あり, main.cpp の編集なし ←fizzbuzz.cpp なし, main.cpp の編集あり
71. ブランチを使う git merge <otherbranch> で変更をマージできる $ git checkout main $ git merge sample-branch # ここでgit commitと同様にコミットメッセージの入力が求められる. デフォルトのメッセージで十分
72. ブランチを使う git merge <otherbranch> で変更をマージできる $ git checkout main $ git merge sample-branch # ここでgit commitと同様にコミットメッセージの入力が求められる. デフォルトのメッセージで十分 このようになる 📄 📄 📄 📄 📄 main sample-branch main を操作したので, sample-branch には変化なし
73. ブランチを使う マージされて用済みのブランチは git branch -d で削除できる # 今読み込んでいるブランチは削除できないので, mainに避難しておく $ git checkout main # sample-branchを削除する $ git branch -d sample-branch # 削除されたことを確認する $ git branch * main
74. ブランチを使う マージされて用済みのブランチは git branch -d で削除できる # 今読み込んでいるブランチは削除できないので, mainに避難しておく $ git checkout main # sample-branchを削除する $ git branch -d sample-branch # 削除されたことを確認する $ git branch * main -d ではなく-D にすればマージしていなくても消せるが, あんまりやる もんではない
75. ブランチ戦略 ブランチの生やし方をチーム内で決めておくと便利
76. ブランチ戦略 ブランチの生やし方をチーム内で決めておくと便利 高専プロコンの開発では「GitHub Flow」が有効 GitHub 運営してる会社が使ってる方法だからこんな名前らしい
77. GitHub Flow 📄 📄 📄 📄 📄 📄 main feature/◯◯ 全体像はこんな感じ
78. GitHub Flow 📄 main 1. main ブランチを開発が中心になる. 本番ではここのプログラムを動かすようにする.
79. GitHub Flow 📄 📄 📄 main feature/◯◯ 2. やること 1 つにつきブランチを 1 つ作ってそこで開発を行う.
80. GitHub Flow 📄 📄 📄 📄 📄 📄 main feature/◯◯ 3. きちんと動作することが確認できたら, main にマージする main には常に安定して動作するようにする
81. GitHub Flow 📄 📄 📄 📄 📄 📄 main 4. feature/◯◯は用済みなので削除する. ブランチ一覧は「やっていることリスト」になる.
82. ブランチの命名 命名規則はなんでもいいが, 一例として • feature/◯◯ 新規機能の実装 • fix/◯◯ バグの修正 • docs/◯◯ ドキュメント(コメントとか)の編集
83. その他 ググれ ChatGPT でもいいです
84. 法的表示 Git Logo | by Jason Long | CC BY 3.0 https://git-scm.com/downloads/logos 色を変更して背景に使用しました.