Zum Inhalt springen

Was ist eine Merge-Queue in GitHub?

Zuletzt aktualisiert am

Eine Merge Queue ist eine GitHub-Funktion, die genehmigte Pull Requests in eine Reihe stellt und jeden davon gegen den neuesten Basis-Branch sowie die davor eingereihten Änderungen testet. Gemergt wird nur, wenn diese Prüfungen erfolgreich sind. So wird verhindert, dass zwei für sich grüne Pull Requests zusammen den Hauptbranch beschädigen.

So funktioniert es

Ohne Queue wird ein Pull Request gegen den Basis-Branch in dem Stand getestet, der beim letzten Push vorlag. Wenn zuvor ein anderer Pull Request gemergt wird, ist Ihr grünes Ergebnis veraltet. Mit einer Queue erstellt GitHub beim Klicken auf „Merge when ready“ einen temporären Branch (eine Merge Group), der den Basis-Branch, die davor liegenden PRs und Ihren PR enthält. Auf diesem kombinierten Stand laufen die erforderlichen Checks. Bestehen sie, wird der PR gemergt. Schlagen sie fehl, wird er aus der Queue entfernt und die nachfolgenden Einträge werden ohne ihn neu aufgebaut.

Die Queue kann mehrere Pull Requests zu einer Merge Group bündeln, um CI-Zeit zu sparen. Die Merge-Methode, die Gruppengröße und die minimale Wartezeit legen Sie in den Einstellungen des Branch-Schutzes bzw. der Rulesets fest.

Beispiel

Erforderliche Status-Checks müssen für das Ereignis merge_group laufen, da sie sonst nie gemeldet werden und die Queue hängen bleibt:

on:
  pull_request:
  merge_group:

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

Das vollständige Setup einschließlich Rulesets finden Sie unter GitHub Merge Queue erklärt.

Häufige Fehler

  • Fehlender merge_group-Trigger. Die häufigste Ursache, wenn ein PR dauerhaft auf „waiting for status“ steht. Fügen Sie ihn jedem Workflow hinzu, der einen erforderlichen Check bereitstellt.
  • Langsame CI. Jeder eingereihte PR wartet auf die Checks, eine 20 Minuten lange Pipeline ergibt daher eine lange Queue. Geschwindigkeit ist hier besonders wichtig; siehe langsame CI.
  • Pfadfilter bei erforderlichen Checks. Wird ein erforderlicher Job durch einen Filter übersprungen, meldet er sich in der Merge Group nie. Verwenden Sie einen abschließenden „Gate“-Job.
  • Annahme, dass es in allen Tarifen funktioniert. Die Verfügbarkeit hängt von Tarif und Repository-Typ ab. Prüfen Sie die aktuelle Dokumentation von GitHub.
  • Aufwendige Test-Suiten doppelt ausführen. Tests laufen am Pull Request und erneut in der Queue. Verlagern Sie aufwendige End-to-End-Tests ausschließlich in die Queue.

Da sich Queue-Läufe stauen, sollte eine Concurrency-Gruppe merge_group-Läufe nicht abbrechen. Brechen Sie ersetzte PR-Läufe ab, niemals Queue-Läufe.

FAQ

Ist eine Merge Queue dasselbe wie Auto-Merge?

Nein. Auto-Merge führt den Merge aus, sobald die Checks auf dem eigenen Commit des PRs bestehen. Eine Merge Queue testet das kombinierte Ergebnis, bevor gemergt wird.

Sind flaky Tests mit einer Queue wichtiger?

Ja. Ein flaky Fehler wirft einen Pull Request aus der Queue und startet die dahinterliegenden Einträge neu. Siehe flaky Tests.

Kann ich die Queue für Hotfixes umgehen?

Administratoren können Branch-Schutzregeln umgehen, sofern das Ruleset dies erlaubt. Nutzen Sie dies nur sparsam.