Rulesetの設定

mainブランチを保護するために、Rulesetを新しく作成します。Rulesetの設定画面はリポジトリのSettingsから開きます。

1. Ruleset作成画面の表示

GitHubのdevopscamp-branch-protection-handsonリポジトリのページを開きます。

Settingsタブをクリックします。

左メニューからRules > Rulesetsを選択します。

New rulesetをクリックし、ドロップダウンからNew branch rulesetを選択します。

2. 基本設定

Rulesetの基本情報を入力します。

設定項目 値 設定の基準
Ruleset Name main-protection ルールセットを識別するための名前
Enforcement status Active ルールを有効化して即座に適用するため

Enforcement statusには、他にDisabled(ルールは存在するが無効)やEvaluate(ルール違反を記録するが強制はしない)があります。Evaluateは本番前の試運転に便利ですが、今回は動作をすぐに確認したいのでActiveを選びます。

3. Bypassリストの設定

Admin権限を持つユーザがPull Request画面から例外的にルールを突破できるよう、Bypassリストを設定します。

Bypass listセクションでAdd bypassをクリックし、Repository adminを選択します。

追加後、Modeを選択します。以下の設定にします。

設定項目 値 設定の基準
Bypass mode Pull requests Pull Request画面からのマージ時のみバイパスを許可する

Bypass modeには2種類あります。

モード 動作
Always 常にルールを無視できる。git pushでの直接Pushも許される
Pull requests Pull Requestのマージ操作時のみバイパスが有効。CLIでの直接Pushは引き続き拒否される

Alwaysを選ぶとadminがCLIでも自由にmainへPushできてしまいます。今回は「CLIでの直接Pushは全員禁止しつつ、Pull Request画面では緊急時にadminがバイパスできる」という実務に近い設定にしたいので、Pull requestsを選択します。

4. 対象ブランチの指定

Rulesetは「どのブランチに対して適用するか」を指定する必要があります。今回はmainブランチに適用します。

Target branchesセクションでAdd targetをクリックし、Include default branchを選択します。これにより、リポジトリのデフォルトブランチ(main)がターゲットに追加されます。

Include default branchを使うことで、将来デフォルトブランチ名を変更した場合でも自動的に新しいデフォルトブランチに追従します。特定のブランチ名で固定したい場合はInclude by patternでブランチ名を指定します。

5. ルールの設定

次に、実際に強制するルールを選びます。画面下部のRulesセクションで、以下の項目にチェックを入れていきます。

5.1 Restrict deletions

この項目にチェックを入れると、mainブランチの削除が禁止されます。誤操作でmainブランチが消えることを防ぐ、基本中の基本となる設定です。

5.2 Require a pull request before merging

この項目にチェックを入れると、mainブランチへの変更はPull Request経由でのみ行えるようになります。これが「mainへの直接Push禁止」を実現する最も重要な設定です。

この項目を有効にすると、追加の設定が表示されます。今回は以下のように設定します。

設定項目 値 設定の基準
Required approvals 0 個人リポジトリでは自分自身のPRを承認できないため、今回は承認なしで進める
Dismiss stale pull request approvals when new commits are pushed OFF 承認数を0にしているため
Require review from Code Owners OFF 個人リポジトリではCODEOWNERSの動作確認ができないため、今回は無効
Require approval of the most recent reviewable push OFF 承認数を0にしているため
Require conversation resolution before merging ON Pull Requestのコメントが未解決のままマージされないようにするため
💡 ポイント
実際にはRequired approvalsを1以上に設定し、「他の開発者の承認がないとマージできない」状態にすることが一般的です。またRequire review from Code Ownersを有効にすると、特定のファイル・ディレクトリの変更時に特定のレビュアーのApproveを強制できます。今回は個人リポジトリのため動作確認はできませんが、チーム開発では必須の設定です。

5.3 Require status checks to pass

この項目にチェックを入れると、指定したCIワークフローが成功していないとマージできなくなります。これが「CIをパスしたコードだけがmainに入る」という品質ゲートの中核的な設定です。

チェックを入れるとAdd checksボタンが表示されるので、クリックします。

検索窓にCheck README existsと入力し、候補に表示される**+ Add Check README exists**(Any source)を選択して追加します。

💡 ポイント
Add checksでは「すでに実行されたことのあるチェック名」から選ぶか、任意の名前を手動で入力して追加できます。手動で追加する場合、ワークフローがまだ一度も実行されていなくても設定できます。入力する名前は、ワークフローのジョブ名(jobs.<job-id>.nameで指定した値)と一致させる必要があります。今回はcheck-readme.ymlでname: Check README existsと指定しているため、Check README existsと入力します。

Require branches to be up to date before mergingはONにします。有効にすると、mainが更新されるたびに作業用ブランチへ最新mainを取り込んでからでないとマージできなくなり、マージ後にmainで予期せぬ競合が発生することを防げます。

Do not require status checks on creationはOFFのままで進めます。このオプションは、Rulesetの対象パターンにマッチするブランチの初回作成Pushで、必須ステータスチェックの要求を免除する設定です。feature/*のようにパターンで対象を広げる運用では、ワークフローが一度も走っていない新規ブランチの初回Pushが拒否されるのを防ぐために有効化しますが、今回はRulesetの対象をmainのみに限定しているためOFFのままで挙動に影響はありません。

5.4 Block force pushes

この項目にチェックを入れると、git push --forceによるmain履歴の書き換えが禁止されます。うっかりforce pushで過去のコミットを失う事故を防ぐ、もう一つの重要な設定です。

6. Rulesetの作成

必要な項目をすべて設定したら、画面下部のCreateボタンをクリックします。

作成後、Rulesetの詳細画面が表示されます。main-protectionがActive状態で表示されていれば、ここまでの操作は完了です。