マージキューの管理

注: pull request のマージキュー機能は現在、パブリックベータ版であり、変更される可能性があります。

マージキューについて

マージキューを使用すると、必要なすべてのブランチ保護チェックに合格することを保証しつつ、pull request がビジー状態のターゲットブランチにマージされる速度を上げることができます。

pull request が必要なすべてのブランチ保護チェックに合格すると、リポジトリへの書き込みアクセス権を持つユーザーは、その pull request をマージキューに追加できます。

マージキューでは、GitHub Actions を使用できます。詳しくは、「GitHub Actionsのドキュメント」を参照してください。

pull request 変更の有効性を検証する特別なプレフィックスを付け、一時的なブランチがマージキューによって作成されます。次に、pull request の変更は、base_branch の最新バージョンとキューでそれに先行する変更と共に、merge_group にグループ化されます。 GitHub では、base_branch のブランチに必須のチェックで合格すると、これらの変更がすべてマージし、base_branch が作られます。

マージ方法について詳しくは、「プルリクエストのマージについて」をご覧ください。

注:

マージキューは、ブランチ名パターンにワイルドカード文字 (*) を使用するブランチ保護ルールで有効にできません。
マージキューは、マージを続ける前に、必要なチェックが報告されるまで待機します。マージキューが必要な場合は、マージグループイベントをトリガーして報告するように、CI の構成を更新する必要があります。

pull request をターゲットブランチの最新バージョンとグループ化し、キュー内でその前に変更した後、必要な状態チェックが失敗した場合、またはベースブランチと競合した場合、GitHub によって pull request がキューから削除されます。 pull request タイムラインには、その pull request がキューから削除された理由が表示されます。

GitHub Actions を使ってマージグループのチェックをトリガーする

merge_group イベントを使って、pull request がマージキューに追加されたときに GitHub Actions ワークフローをトリガーできます。これは pull_request イベントや push イベントとは異なるイベントであることに注意してください。

注: リポジトリで GitHub Actions を使ってリポジトリ内の pull request に対して必要なチェックを実行する場合は、追加のトリガーとしてmerge_group イベントを含めるようにワークフローを更新する必要があります。それ以外の場合、マージキューに pull request を追加しても、ステータスチェックがトリガーされません。必要な状態チェックが報告されないため、マージは失敗します。

ターゲットブランチの保護で必要なチェックを報告するワークフローは、次のようになります。

on:
  pull_request:
  merge_group:

詳しくは、「ワークフローをトリガーするイベント」を参照してください。

他の CI プロバイダーを使ってマージグループのチェックをトリガーする

他の CI プロバイダーを使う場合、特別なプレフィックス gh-readonly-queue/{base_branch} で始まるブランチが作成されたときに実行するように CI 構成を更新する必要がある場合があります。