Zum Inhalt springen

Was ist eine Concurrency-Gruppe in GitHub Actions?

Zuletzt aktualisiert am

Eine Concurrency-Gruppe ist ein benannter Schlüssel in einem GitHub Actions Workflow oder Job, der zu einem Zeitpunkt nur einen Run mit diesem Schlüssel zulässt. Neuere Runs warten oder brechen, mit cancel-in-progress: true, den noch laufenden älteren Run ab.

So funktioniert es

Sie fügen einen concurrency-Block mit einer group-Zeichenkette hinzu. GitHub wertet die Zeichenkette für jeden Run aus. Läuft bereits ein anderer Run mit derselben Gruppe, wird der neue Run als ausstehend zurückgehalten. Ist cancel-in-progress auf true gesetzt, wird stattdessen der alte Run abgebrochen und der neue sofort gestartet.

Pro Gruppe kann nur ein Run ausstehend sein. Kommt ein dritter Run hinzu, während einer läuft und einer wartet, wird der wartende Run zugunsten des neuesten verworfen, sofern Sie nicht den laufenden Run abbrechen.

Die Gruppenzeichenkette kombiniert meist den Workflow-Namen und eine Ref, sodass jeder Branch bzw. jeder Pull Request seine eigene Spur hat. Das Abbrechen überholter Runs bei einem stark genutzten Pull Request ist eine der einfachsten Möglichkeiten, verschwendete CI-Minuten zu reduzieren.

Beispiel

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

Hier erhält jeder Pull Request seine eigene Gruppe, und alte Runs werden bei einem neuen Push abgebrochen. Pushes auf main erhalten eine Gruppe pro Ref und werden in die Warteschlange gestellt statt abgebrochen, sodass jeder Commit auf main getestet wird.

Das funktioniert auch auf Job-Ebene, etwa um Deployments zu serialisieren:

jobs:
  deploy:
    concurrency:
      group: production-deploy
      cancel-in-progress: false
    runs-on: ubuntu-latest
    steps:
      - run: ./deploy.sh

Häufige Fehler

  • Deployments mittendrin abbrechen. Ein abgebrochenes Deployment kann die Infrastruktur in einem fehlerhaften Zustand zurücklassen. Verwenden Sie für Deployments cancel-in-progress: false.
  • Gruppe zu weit gefasst. Eine feste Zeichenkette wie ci über alle Branches hinweg führt dazu, dass sich unabhängige Pull Requests gegenseitig abbrechen.
  • Runs auf main abbrechen. Das Abbrechen von Runs auf dem Standard-Branch verdeckt, welcher Commit den Build gebrochen hat.
  • Runs der Merge Queue abbrechen. Runs aus dem Ereignis merge_group sollten nicht abgebrochen werden; siehe Merge Queue.
  • Workflow-Namen vergessen. Zwei verschiedene Workflows mit derselben Gruppe teilen sich eine Spur und brechen sich gegenseitig ab.

Um die Kosten weiter zu senken, lesen Sie wie Sie Ihre GitHub Actions Rechnung reduzieren.

FAQ

Worin unterscheidet sich Concurrency auf Workflow- und Job-Ebene?

Concurrency auf Workflow-Ebene steuert ganze Runs. Concurrency auf Job-Ebene steuert einen einzelnen Job und eignet sich, um eine gemeinsam genutzte Ressource wie ein Deployment-Ziel zu sperren.

Spart cancel-in-progress Geld?

Ja. Überholte Runs verbrauchen keine Minuten mehr. Wie viel gespart wird, hängt davon ab, wie oft Sie in offene Pull Requests pushen.

Werden abgebrochene Runs berechnet?

Minuten, die vor dem Abbruch verbraucht wurden, werden berechnet. Minuten nach dem Abbruch nicht.