コンテンツへスキップ

GitHubのマージキューとは何ですか?

最終更新

マージキューは、承認されたプルリクエストを順番に並べ、それぞれを最新のベースブランチと、その前に並んでいる変更を加えた状態でテストする GitHub の機能です。チェックが通った場合にのみマージされるため、個別には成功している2つのプルリクエストが組み合わさって main ブランチを壊すことを防ぎます。

仕組み

キューがない場合、プルリクエストは最後のコミットがプッシュされた時点のベースブランチに対してテストされます。他のプルリクエストが先にマージされると、成功した結果は古くなります。キューがあれば、「Merge when ready」をクリックしたときに、GitHub がベースブランチ、前に並ぶ PR、そして自分の PR を含む一時ブランチ(マージグループ)を作成します。その組み合わせた状態で必須チェックを実行し、通ればマージされます。失敗した場合はキューから除外され、後続のエントリーは除外された PR を抜いた状態で再構築されます。

CI 時間を節約するため、キューは複数のプルリクエストを1つのマージグループにまとめることができます。マージ方法、グループサイズ、最低待機時間は、ブランチprotection またはルールセットの設定で指定します。

例

必須ステータスチェックは merge_group イベントに対して実行される必要があります。そうしないとチェックが報告されず、キューが停止します:

on:
  pull_request:
  merge_group:

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm ci && npm test

ルールセットを含む完全な設定手順は、GitHub のマージキューの解説をご覧ください。

よくある間違い

  • merge_group トリガーの指定漏れ。 PR が「ステータスを待機中」のまま止まる最も一般的な原因です。必須チェックを提供するすべてのワークフローに追加してください。
  • CI の遅さ。 キューに入った各 PR はチェックの完了を待つため、パイプラインが20分かかると、キューは長くなります。ここでは速度がより重要です。CI の遅さを参照してください。
  • 必須チェックへのパスフィルター適用。 必須ジョブがフィルターでスキップされると、マージグループに対して報告されることはありません。最後に「gate」ジョブを使用してください。
  • すべてのプランで動作すると思い込むこと。 利用可否はプランとリポジトリの種類によって異なります。GitHub の最新のドキュメントをご確認ください。
  • 重いテストスイートの二重実行。 テストはプルリクエスト上と、キュー内で再度実行されます。重いエンドツーエンドテストはキューでのみ実行するようにしてください。

キューに入った実行は積み重なるため、同時実行グループで merge_group の実行をキャンセルしないでください。置き換えられた PR の実行はキャンセルしてよいですが、キューの実行はキャンセルしないでください。

よくある質問

マージキューは自動マージと同じものですか?

いいえ。自動マージは、PR 自身のコミットでチェックが通ると即座にマージします。マージキューは、マージ前に組み合わせた結果をテストします。

キューを使うと、不安定なテストはより重要になりますか?

はい。不安定な失敗が起きると、そのプルリクエストは除外され、後ろのエントリーが再開されます。不安定なテストを参照してください。

緊急修正ではキューを飛ばせますか?

ルールセットで許可されていれば、管理者はブランチ保護をバイパスできます。使用は必要最小限にしてください。