GitHub の PR を承認してマージする
登録したリポジトリの PR を申請し、承認でマージする流れをまとめたページです。接続とリポジトリの登録は GitHub と接続する を見てください。
- 「運用オペレーション」の「新しいオペレーション」を開き、「GitHub の PR を取り込む」を開いて PR の URL を貼ります。
- 「プレビュー」を押します。差分、CI、事前チェック、ルールの評価が表示されます。
- 内容を確認して「承認を依頼」を押します。承認経路は登録リポジトリの設定に従います。
申請を作ると、PR の head に承認チェック Actagate / approval が「待ち」で付きます。自前の App では、アプリ表示名に合わせたチェック名になります。チェックの詳細リンクから申請詳細に戻れます。
承認者は申請詳細で PR の内容を確認し、承認または却下します。承認が完了すると承認チェックが「成功」になり、PR に承認者と申請の URL をコメントします。却下、差し戻し、取り下げでは承認チェックが「失敗」になり、理由を添えてコメントします。人が作った PR は閉じません。
承認後に PR へ push があると、申請詳細を開いたときとマージの直前に気づきます。承認チェックは新しい head ごとに1回だけ「待ち」に戻り、申請詳細に「承認後に PR が変わった。複製して下書きにする」が出ます。リンクを押すと同じ PR の URL が入った取り込み画面が開くので、もう一度申請してください。
マージの仕方が「承認後にアプリがマージ」のリポジトリでは、実行担当者が実行コンソールでマージします。
- 申請詳細の「実行コンソールを開く」を押し、「実行を開始する」を押します。
- 危険操作の確認に PR 番号を入力し、「実行する」を押します。
マージの直前に次を確かめ、1 つでも外れたら失敗にして止めます。自動では再試行しません。理由は申請詳細と実行ログに残ります。
- head SHA が承認時と同じ
- PR が open で、mergeable が true
- 必須の check が成功している
- 承認チェックが成功している
マージ方式が「リポジトリの既定」なら、リポジトリで許可された squash、merge、rebase の順に選びます。マージコミットの SHA は証跡に残ります。
マージの仕方が「承認チェックだけ」のリポジトリでは、承認の完了で手順が完了になります。マージは人が GitHub で行います。ブランチ保護で承認チェックを必須にしておくと、承認前のマージを GitHub が止めます。
結果を見守る
Section titled “結果を見守る”見守るワークフローを設定したリポジトリでは、マージ後にマージコミットに対する run を探します。取りに行くのは、申請詳細を開いたとき、申請詳細の「結果を確認する」を押したとき、実行コンソールで「状態を確認する」を押したときです。常駐の監視はありません。
| run の状態 | 手順の状態 |
|---|---|
| 成功 | 完了。run の URL と結論を証跡に残す |
| 失敗 | 要対応。申請詳細にジョブのログの末尾を出す |
| 上限の時間内に run が無い、または終わらない | 結果不明として要対応 |
失敗した run は人が GitHub で直し、再実行します。結果は実行コンソールで記録してください。
実行コンソールで GitHub の API が使えない、権限が無い、レート制限に当たった場合は、手順がコピー対応に戻ります。実行コンソールに gh pr merge <番号> --repo <owner>/<name> --squash --match-head-commit <sha> の形のコマンドと、設定の「コピー対応の手順」、PR の URL、承認済みの head SHA が出ます。
- コマンドを手元で実行し、人がマージします。
- 実行コンソールの「実行結果」にマージコミットの SHA (40 桁) を貼ります。見守るワークフローがある場合は run の URL (
https://github.com/<owner>/<name>/actions/runs/<番号>) も貼ります。 - 「結果を記録する」を押します。どちらかが足りないと記録できず、手順は実行可能のまま残ります。
workflow_dispatch を手で実行するときは、申請 ID を入力して run に残します。入力欄の書き方は GitHub と接続する にあります。
ブランチ保護で承認チェックを必須にする
Section titled “ブランチ保護で承認チェックを必須にする”GitHub のリポジトリ設定でブランチの保護を編集し、Require status checks to pass before merging を有効にして Actagate / approval を必須にします。設定画面の「ブランチ保護の設定を確認する」で、保護の有無と必須チェックの一覧を確かめられます。
ブランチ保護を使えないリポジトリでは、マージの仕方を「承認後にアプリがマージ」にし、ワークフローの先頭に if: github.actor != 'actagate[bot]' で失敗する判定を入れます。人が直接 push した変更はそのジョブで止まり、次に承認されたマージのときにまとめて適用されます。
GitHub がマージ可否を計算中なら、時間を置いて再試行してください。閲覧時の見守りで通信に失敗しても、監視中の状態は変えません。
コピーコマンドの方式は設定に従います。「リポジトリの既定」では --squash などの方式フラグを付けません。実行すると gh がリポジトリで許可された方式から選ぶよう尋ねます。plan にも「リポジトリの既定」と表示します。