GitHub

どのようなものか

GitHubはMicrosoft傘下のホスティングサービスです。Gitリポジトリーを自
らのサーバーへ置き、コードと履歴のウェブ表示、変更を提案してレビュー
するプルリクエスト、作業を追跡するための課題管理、リポジトリーの出来
事に応じて処理を自動実行するGitHub
Actionsを提供します。

土台は普通のGitです。GitHubから複製したものは全履歴を持つ通常のリポ
ジトリーで、ノートPCとの間は通常のプッシュと取得でやり取りします。加
わるものはGitHub側にあります。レビューの議論、課題、ブランチ規則、自
動化設定、誰に何を許すかの一覧は、複製の中でなく、GitHub自身のシステ
ムへ保存します。

GitHubでいうプルリクエストは、一ブランチの変更を別のものへマージする
提案です。行ごとの差分、コメントと承認、提案コードに対して実行した全
自動検査の結果を示します。下書きなら未完成と表示し、レビュー可能と指
定するまでマージできません。

GitHub
Actionsは組み込みの自動化です。ワークフローは、リポジトリーの
`.github/workflows`ディレクトリーに置くYAMLファイルで、プッシュ、新
しいプルリクエスト、時刻指定など、起動する出来事と、ステップからなる
ジョブを定義します。ステップはシェルコマンドか、リポジトリー間で共有
できるようパッケージ化された自動処理であるアクションを実行します。
ジョブを動かすのはランナーです。GitHubが毎回新しく起動するUbuntu
Linux、Windows、macOSの仮想マシンか、自前で登録したセルフホストのマ
シンを使います。

入ってくるものを監視するサービスが二つあります。Dependabotは
`dependabot.yml`を読み、依存関係を更新するプルリクエストと、既知の脆
弱性のある依存関係を直す別のプルリクエストを作ります。プッシュ保護は
アクセストークンなどの機密情報を検査し、リポジトリーへ入る前に止めま
す。

なぜ重要なのか

多くのチームにとって、保存場所だけでなく仕事の場所です。コード、変更
の議論、承認者の記録、各検査の結果が並び、一行がなぜあるかを、一ペー
ジから調べられることが多いのです。

自動化もホスティングと同じくらい重要です。Actionsがコードの隣にある
と、テストを実行して合格した、ビルドが成功した、スキャナーが検出結果
を報告したという証拠を提案へ添えられます。保護ブランチは、それを規則
にします。プルリクエスト経由だけ、一定数の承認後だけ、指定したステー
タスチェックの合格後だけに変更を許し、レビューと検査を通る変更だけで
主系統を進められます。

コードの入口にあるため、供給網の管理点でもあります。どの第三者アク
ションをどの正確な版で動かすか、依存関係をどう更新するか、機密情報を
送信時に止めるかを決めます。多くはリポジトリーや組織ごとに有効化、調
整するため、実際の安全性の大きな部分は、コードレビューでは見えない設
定にあります。

これがホスティングサービスの交換条件です。サーバーを動かさずに、一式
がそろい保守も行われる環境を得られますが、保護規則は他者の画面で設定
し、既定値は自分の事情でなく一般向けに選ばれています。

実際の活用例

自社の仕事の三つの事例が、GitHubのそれぞれ違う役割を示します。

GitHub
Actionsによるデリバリーパイプラインは、コード品質ゲート用を一つ、テ
スト用を一つ、デプロイ用を環境ごとに一つと、ワークフローを分け、
CodeQL、依存関係レビュー、ソフトウェア部品表の処理も並行して動かしま
す。コミットからAzureで動くサービスまでをつなぎ、ビルドの昇格を手作
業で行う代わりに、定義した経路で各環境へ進めます。フロントエンドは
シェルもパッケージマネージャーもないdistrolessイメージ、Go
APIは軽量なAlpineベースで配信します。

継続的なセキュリティ検査は、コードの周囲の管理を使います。第三者の
GitHub
Actionはすべてタグでなくコミットハッシュへ固定し、タグの移動で実行内
容が変わらないようにします。Dependabotは6エコシステムを監視し、
Gitleaksは履歴から認証情報を探し、各ビルドはAnchoreとSyftで部品表を
作ります。事例は報告量という代償も挙げます。すべてを報告する検査器は
無視を招くため、有用な検出結果を保つには、継続的な仕分けが必要です。

GISのSaaSアプリのデプロイでは、テスト、ビルド、デプロイをGitHub
Actionsへ移し、担当者が手順を覚えていることに依存しなくしました。定
期的なデータ処理とレポートも、Python、Bash、SQLの定時処理へ移し、設
定と機密情報を標準化して各環境の動作をそろえました。

ワークフローでの固定は次の形です。長い十六進数はレビューしたリリース
の完全なコミット識別子で、コメントには人が読める版を残します。

```yaml
steps:
    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
```

問題が起きるところ

  * タグへ固定したアクションが、知らせず変わります。
`v4`などのタグは、アクションのリポジトリーを管理する人が移動や削除で
き、明日動くコードが今日レビューしたものとは違い得ます。GitHubは完全
なコミットSHAへの固定を勧めます。偽装には「有効なGitオブジェクトの内
容に対するSHA-1衝突」を作る必要があるためです。

  * トークンが仕事以上の権限を持ちます。
毎回渡す`GITHUB_TOKEN`の権限で、侵害されたステップが変えられる範囲も
決まります。GitHubは、リポジトリー内容の読み取りを既定とし、必要な
ジョブだけへ書き込みを許すよう勧めます。

  * 信頼できない文章がコマンドになります。
プルリクエストの題名を直接インラインスクリプトへ埋めると、入力者が処
理の一部を決められます。中間の環境変数へ置けばデータのままです。
`pull_request_target`と`workflow_run`は高権限の処理を起動し、その中
で信頼できないプルリクエストをチェックアウトすると、リポジトリーが侵
害の危険にさらされると、GitHubは警告します。

  * 管理者がブランチ規則を素通りします。
既定では管理者権限の人を保護規則の制限から除きます。上記設定の回避を
許可しないという意味の「Do not allow bypassing
the above settings」を有効にすると、管理者にも適用します。

  * 機密情報がプッシュ保護をすり抜けます。
既定で有効なものは、各利用者自身が公開リポジトリーへ送るプッシュを保
護します。全貢献者からの送信を守るリポジトリー単位のものにはGitHub
Secret
Protectionが必要で、有効にするまで無効です。有効でも書き込み権限があ
れば理由を付けて回避でき、アラートが発生し、監査ログにも記録されま
す。送った認証情報は全複製にあるため、履歴の書き換えに頼らず交換して
ください。

参考資料

  * GitHub Docs — リポジトリー、プルリクエスト、Actions、セキュリ
ティ機能に関する包括的なドキュメントです。

  * GitHub Actionsを理解する — ワークフロー、イベント、ジョブ、ス
テップ、ランナーの関係です。

  * 安全な利用の参照文書 — 固定、トークン権限、スクリプト注入につい
てのGitHub自身の説明です。

  * 保護ブランチについて — 必須レビュー、必須のステータスチェック、
それらを回避できる人を説明します。

  * Dependabotのバージョン更新 — `dependabot.yml`が更新の提案を動か
す仕組みです。

  * プッシュ保護 — 二種類が止めるものと、回避の記録です。

hこのページのウェブ版	URL:https://engineer.company/ja/glossary/github/	engineer.company	70
