本章の概要
この章では、GitHubのRulesets機能を使ったmainブランチ保護の設定をハンズオン形式で学習します。これにより、直接Push禁止・必須ステータスチェックなど、CIをパスしたコードだけをマージさせる運用ができるようになります。
1. 本章の目的
GitHub Actionsで自動化を進めても、「mainブランチに直接Pushされた」「git push --forceで履歴が書き換わった」といった穴が残るとCIをすり抜けたコードが本番にデプロイされてしまいます。GitHubのRulesetsを使ってmainブランチに保護ルールを設定すると、これらの穴を塞ぎ、CIをパスしたコードだけがマージされる運用が実現できます。
2. ハンズオンの流れ
GitHubのRulesets機能を使って、mainブランチの削除禁止・Pull Request必須・必須ステータスチェック・Force Push禁止・Bypassの5つの保護ルールを設定します。ルールを違反する変更と満たす変更をそれぞれ試して、実際の動作を確認します。
3. 事前準備
3.1 前提となる講座
この章では、以下の知識を前提としています。自信がない場合は先に関連講座を実施してみましょう。
| 講座名 | 必要な知識 |
|---|---|
| Git入門 | リポジトリ作成、コミット、Push、ブランチ操作など、Gitの基本操作 |
3.2 必要なツール
この章では、以下のツールを使用します。まだインストールしていない場合は、リンク先の手順に沿って準備をお願いします。
| ツール名 | 関連箇所 | 理由 |
|---|---|---|
| Visual Studio Code | Visual Studio Codeのインストール | ブランチ操作の対象となるコードを編集するエディタとして使用する |
| Git | Git/GitHubのセットアップ | 保護ブランチの動作を確認するローカル操作に使用する |
3.3 必要なアカウント
この章では、以下のアカウントを使用します。まだ用意していない場合は、リンク先の手順に沿って準備をお願いします。
| アカウント名 | 関連箇所 | 理由 |
|---|---|---|
| GitHubアカウント | Git/GitHubのセットアップ | 保護ブランチを設定するリポジトリのホスティング先として使用する |
4. 今回設定する保護ルール
今回のハンズオンでは、Rulesetsで以下のルールを設定します。
| ルール | 内容 |
|---|---|
| Restrict deletions | 指定したブランチの削除を禁止する |
| Require a pull request before merging | 指定したブランチへの変更はPull Request経由のみに限定する |
| Require status checks to pass | 指定したCIワークフローが成功しないとマージできない |
| Block force pushes | git push --forceによる指定したブランチの履歴書き換えを禁止する |
| Bypass list | Admin権限を持つユーザだけがPull Request画面からルールを例外的にバイパスできる |
平常時は全員にルールを強制し、緊急時のみ責任者がバイパスする、という実務的な運用を体験できます。
| 📝 Rulesetsとは |
|---|
| Rulesetsは、GitHubがリポジトリ・Organizationのブランチ保護を柔軟に定義するために提供している仕組みです。GitHubは新規に保護設定を行う場合はRulesetsの利用を推奨しています。詳しくはAbout rulesetsに記載があります。 |