GITHUB · 入門
GitHub入門:Gitとの違い・リポジトリ・PRと共同開発
GitHubは、Gitリポジトリの共有と共同作業を支援するサービスです。Gitが履歴を記録し、GitHubはその履歴を使った議論・レビュー・検査をまとめます。履歴を置くこと、一般へ公開すること、変更を承認することを分けて学びます。
GitとGitHubの役割を分け、公開範囲・ブランチ・PR・権限の関係を説明できる。
コミットは変更の記録、ブランチは履歴上の位置を指す名前です。前のGit教材のSQL変更を使いますが、このページでも意味を確認できます。
GitとGitHubは、どこで役割が分かれる?
作業ファイル、ステージ、コミットとブランチを扱う。
プロジェクトの履歴を共有する場所。公開範囲と権限を決める。
変更を取り込む提案を作り、差分と議論をまとめる。
人の判断と自動検査を見て、取り込みを検討する。
履歴の共有と、変更を承認する判断は別です。GitHubのリポジトリがあるだけで、変更が本番へ配信されるわけではありません。
リポジトリは、ファイルとその変更履歴を管理する単位です。架空のdemo-acme/report-infraなら、demo-acmeが所有者、report-infraがリポジトリ名です。GitHubには履歴に加え、変更の議論や作業の管理を支援する機能があります。
公開範囲と、操作を許す権限を分ける
| 判断 | 確認すること |
|---|---|
| 誰に見せるか | publicは広く閲覧可能。privateは許可された範囲。利用可能な公開範囲は契約等にもよる。 |
| 誰が何をできるか | 閲覧、更新、管理、レビュー等の権限と保護ルールを確認する。 |
privateは公開範囲の設定で、変更コードの安全判定ではありません。 読める共同作業者にも誤りや悪意はあり得ます。秘密をファイルへ書いてコミットすると、閲覧者や過去の履歴、複製から漏れる可能性があります。機密値をcommitしないことと、実行時の権限を絞ることを両方考えます。
ブランチの変更を、PRで提案する
mainが変更前Bを指し、feature/jp-report-filterが提案Hを指す例です。Hでは、承認済みレポートの読取り条件へregion = JPを加えます。ブランチへ変更を記録したことと、mainへ取り込んだことは別です。B・Hは説明用の名前です。
PR #42は、その変更をmainへ取り込んでよいか相談する架空の提案です。Files changedで差分、Conversationで説明と議論、Commitsで提案の履歴、Checksで検査を確認します。R-BというUSの承認済み行が外れるなら、「それは要件どおりか」がレビューの質問になります。
| 判断 | 意味 |
|---|---|
| Comment | 意見や質問を残す。承認や修正要求とは区別する。 |
| Approve | 変更の取り込みを支持する。実際のマージや配信とは別。 |
| Request changes | 取り込む前に対応してほしい変更を示す。 |
検査の成功は、人が要件へ合うと判断したことと同じではありません。取り込みが可能かは、現在の差分・必要な承認・必須検査・権限・例外設定を合わせて確認します。PRを開いただけで、承認やマージが済むわけではありません。
他者の変更を読むことと、実行すること
forkは、元のリポジトリと履歴を共有する別のリポジトリです。そこから変更を提案する開発方法もあります。GitHub上で読めるソースでも、未審査のコードやworkflowを強い権限で動かしてよいとは限りません。
- SQLや設定ファイルだけでなく、workflow・依存・実行先の変更も読む。
- secretやtokenを誰に渡し、runnerがどこへ接続できるかを確認する。
- 公開範囲の設定と、レビュー済み・検査済み・配信済みという状態を別に扱う。
GitHubの役割を確かめる
選択すると、正誤と理由が表示されます。
確認して、自分の言葉で説明する
- ローカルGitとGitHubの仕事を一つずつ説明する。
- privateと、変更を実行してよいという判断を分ける。
- PRの提案・承認・マージを、別の状態として読む。
理解を確かめる: privateリポジトリのPRなら、未審査のコードへ配信権限を渡してよい?
いいえ。公開範囲と実行コードの信頼を別に判断します。
privateは閲覧の範囲です。runnerや認証情報へアクセスさせるかは、変更内容と処理の権限で判断します。
出典と確認した条件
説明に用いた一次資料を、確認した内容・条件と本文の参照箇所に分けてまとめています。専門家による監修・実環境での検証は行っていません。
確認した内容・条件履歴を置く場所、共同作業、公開範囲の基本。GitHub.comを想定。 公式資料の確認であり、実環境の検証ではありません。
参照した本文GitとGitHubは、どこで役割が分かれる? 公開範囲と、操作を許す権限を分ける GitHubの役割を確かめる
確認した内容・条件変更提案、PRの各表示と検査用ref。現在のbase先端と共通祖先の違い。 公式資料の確認であり、実環境の検証ではありません。
参照した本文GitとGitHubは、どこで役割が分かれる? ブランチの変更を、PRで提案する 他者の変更を読むことと、実行すること
確認した内容・条件プラン・公開範囲と保護設定による必須検査・承認、古い承認の扱い。 公式資料の確認であり、実環境の検証ではありません。
確認した内容・条件非信頼コードと特権処理、secret、第三者action、self-hosted runnerの残存状態。 公式資料の確認であり、実環境の検証ではありません。
確認した内容・条件environmentと保護機能のプラン・公開範囲による条件差。 公式資料の確認であり、実環境の検証ではありません。
参照した本文公開範囲と、操作を許す権限を分ける
確認した内容・条件Comment・Approve・Request changesの意味。 公式資料の確認であり、実環境の検証ではありません。
参照した本文ブランチの変更を、PRで提案する