Zum Inhalt springen

Was ist ein wiederverwendbarer Workflow in GitHub Actions?

Zuletzt aktualisiert am

Ein wiederverwendbarer Workflow ist eine GitHub-Actions-Workflow-Datei, die andere Workflows wie einen einzelnen Job aufrufen können. Er deklariert den workflow_call-Trigger, nimmt Inputs und Secrets entgegen und kann Outputs zurückgeben. So können Teams eine Pipeline einmal definieren und über mehrere Repositories hinweg wiederverwenden.

So funktioniert es

Der aufgerufene Workflow deklariert on: workflow_call mit optionalen inputs, secrets und outputs. Der aufrufende Workflow fügt einen Job mit uses: hinzu, der auf die Datei verweist, entweder im selben Repository (./.github/workflows/ci.yml) oder in einem anderen (org/repo/.github/workflows/ci.yml@ref), und übergibt Werte mit with: und secrets:.

Der aufgerufene Workflow führt seine Jobs auf den eigenen Runnern aus. Sein runs-on wird darin festgelegt. Um eine gemeinsame Pipeline auf schnellere Maschinen umzustellen, ändern Sie also eine Datei statt jedes einzelnen Repositorys.

Ein wiederverwendbarer Workflow unterscheidet sich von einer Composite Action. Eine Composite Action bündelt Steps innerhalb eines Jobs. Ein wiederverwendbarer Workflow bündelt ganze Jobs mit eigenen Runnern, Matrizen und Services.

Beispiel

Aufgerufener Workflow, .github/workflows/node-ci.yml in acme/shared:

on:
  workflow_call:
    inputs:
      node-version:
        type: string
        default: "22"
    secrets:
      NPM_TOKEN:
        required: false

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ inputs.node-version }}
          cache: npm
      - run: npm ci && npm test

Caller:

jobs:
  ci:
    uses: acme/shared/.github/workflows/node-ci.yml@v1
    with:
      node-version: "20"
    secrets: inherit

Häufige Fehler

  • Nicht fixierte Referenzen. @main bedeutet, dass jeder Push ins gemeinsame Repository alle aufrufenden Workflows verändert. Fixieren Sie einen Tag oder SHA.
  • Zu tiefe Verschachtelung. Es gibt eine Begrenzung, wie viele Ebenen wiederverwendbarer Workflows sich gegenseitig aufrufen dürfen.
  • Erwartung, dass env durchgereicht wird. Umgebungsvariablen, die im aufrufenden Workflow gesetzt sind, sind im aufgerufenen Workflow nicht sichtbar. Übergeben Sie stattdessen Inputs.
  • Secrets erreichen den aufgerufenen Workflow nicht. Übergeben Sie sie explizit oder verwenden Sie secrets: inherit, wo dies erlaubt ist.
  • Überraschungen bei Berechtigungen. Der aufgerufene Workflow kann keine größeren GITHUB_TOKEN-Berechtigungen erhalten, als der aufrufende Workflow gewährt.
  • Eine Matrix-Build darin verbergen, ohne Inputs bereitzustellen, sodass Aufrufer sie nicht anpassen können.

Wiederverwendbare Workflows helfen außerdem bei einheitlichen Concurrency-Gruppen und Sicherheitseinstellungen. Hinweise zum Fixieren finden Sie unter GitHub Actions absichern.

FAQ

Können private Repositories Workflows gemeinsam nutzen?

Ja, sofern die Actions-Zugriffseinstellungen des Repositorys erlauben, dass andere Repositories der Organisation sie verwenden.

Wie werden sie abgerechnet?

Jobs im aufgerufenen Workflow verbrauchen Minuten wie jeder andere Job. Der Aufruf selbst verursacht keine gesonderte Gebühr.

Worin unterscheidet sich das von einer Vorlage?

Eine Vorlage wird kopiert. Auf einen wiederverwendbaren Workflow wird verwiesen, daher erreichen Aktualisierungen die Aufrufer entsprechend der von Ihnen fixierten Referenz.