GitHub Webhook-Ereignisse - AWS CodeBuild

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

GitHub Webhook-Ereignisse

Sie können Webhook-Filtergruppen verwenden, um anzugeben, welche GitHub Webhook-Ereignisse einen Build auslösen. Sie können beispielsweise angeben, dass ein Build nur bei Änderungen an bestimmten Branches ausgelöst wird.

Sie können eine oder mehrere Webhook-Filtergruppen erstellen, um anzugeben, welche Webhook-Ereignisse einen Build auslösen. Ein Build wird ausgelöst, wenn eine Filtergruppe als wahr ausgewertet wird. Dies ist der Fall, wenn alle Filter in der Gruppe den Wert true ergeben. Beim Erstellen einer Filtergruppe geben Sie Folgendes an:

Ein Ereignis

Für GitHub können Sie eines oder mehrere der folgenden Ereignisse auswählen:PUSH,PULL_REQUEST_CREATED,PULL_REQUEST_UPDATED,PULL_REQUEST_REOPENED,PULL_REQUEST_MERGED, PULL_REQUEST_CLOSEDRELEASED,PRERELEASED, undWORKFLOW_JOB_QUEUED. Der Webhook-Ereignistyp ist im X-GitHub-Event-Header in der Webhook-Nutzlast zu finden. Im X-GitHub-Event-Header befindet sich möglicherweise pull_request oder push. Bei einem Pull-Anforderungstyp befindet sich der Typ im Feld action der Webhook-Ereignisnutzlast. Aus der folgenden Tabelle geht die Zuordnung der X-GitHub-Event-Header-Werte und der Werte im Feld action der Webhook-Pull-Anforderungsnutzlast zu den verfügbaren Ereignistypen hervor.

X-GitHub-Event-Header-Wert action-Wert der Webhook-Ereignisnutzlast Ereignistyp
pull_request opened PULL_REQUEST_CREATED
pull_request reopened PULL_REQUEST_REOPENED
pull_request synchronize PULL_REQUEST_UPDATED
pull_request closed und das merged-Feld sind true PULL_REQUEST_MERGED
pull_request closed und das merged-Feld sind false PULL_REQUEST_CLOSED
push – PUSH
release veröffentlicht RELEASED
release vorveröffentlicht PRERELEASED
workflow_job queued WORKFLOW_JOB_QUEUED
Anmerkung

Der PULL_REQUEST_REOPENED Ereignistyp kann nur mit GitHub GitHub Enterprise Server verwendet werden. Der PRERELEASED Ereignistyp RELEASED und kann GitHub nur mit verwendet werden. Weitere Informationen zu WORKFLOW_JOB_QUEUED finden Sie unter Tutorial: Einen CodeBuild -gehosteten GitHub Actions-Runner konfigurieren.

Ein oder mehrere optionale Filter

Verwenden Sie einen regulären Ausdruck, um einen Filter anzugeben. Damit ein Ereignis einen Build auslöst, muss jeder Filter innerhalb der Gruppe, die diesem Ereignis zugeordnet ist, als wahr ausgewertet werden.

ACTOR_ACCOUNT_ID(ACTOR_IDin der Konsole)

Ein Webhook-Ereignis löst einen Build aus, wenn eine GitHub oder GitHub Enterprise Server-Konto-ID dem regulären Ausdrucksmuster entspricht. Dieser Wert befindet sich in der Eigenschaft id des Objekts sender in der Webhook-Nutzlast.

HEAD_REF

Ein Webhook-Ereignis löst einen Build aus, wenn die Hauptreferenz mit dem Muster eines regulären Ausdrucks übereinstimmt (z. B. refs/heads/branch-name oderrefs/tags/tag-name). Bei einem Push-Ereignis ist der Referenzname in der Eigenschaft ref in der Webhook-Nutzlast zu finden. Bei Pull-Anforderungsereignissen befindet sich der Branch-Name in der Eigenschaft ref des Objekts head in der Webhook-Nutzlast.

BASE_REF

Ein Webhook-Ereignis löst einen Build aus, wenn die Basisreferenz mit dem Muster eines regulären Ausdrucks übereinstimmt (z. B.refs/heads/branch-name). Ein BASE_REF-Filter kann nur für Pull-Anforderungsereignisse verwendet werden. Der Branch-Name befindet sich in der Eigenschaft ref des Objekts base in der Webhook-Nutzlast.

FILE_PATH

Ein Webhook löst einen Build aus, wenn der Pfad einer geänderten Datei dem Muster regulärer Ausdrücke entspricht. Ein FILE_PATH Filter kann für GitHub Push- und Pull-Request-Ereignisse sowie für GitHub Enterprise Server-Push-Ereignisse verwendet werden. Er kann nicht mit GitHub Enterprise Server-Pull-Request-Ereignissen verwendet werden.

COMMIT_MESSAGE

Ein Webhook löst einen Build aus, wenn die Head-Commit-Nachricht dem Muster eines regulären Ausdrucks entspricht. Ein COMMIT_MESSAGE Filter kann für GitHub Push- und Pull-Request-Ereignisse sowie für GitHub Enterprise Server-Push-Ereignisse verwendet werden. Er kann nicht mit GitHub Enterprise Server-Pull-Request-Ereignissen verwendet werden.

TAG_NAME

Ein Webhook löst einen Build aus, wenn der Tag-Name der Version mit dem Muster des regulären Ausdrucks übereinstimmt. Ein TAG_NAME Filter kann für GitHub veröffentlichte und vorab veröffentlichte Anforderungsereignisse verwendet werden.

RELEASE_NAME

Ein Webhook löst einen Build aus, wenn der Versionsname dem Muster eines regulären Ausdrucks entspricht. Ein RELEASE_NAME Filter kann für GitHub veröffentlichte und vorab veröffentlichte Anforderungsereignisse verwendet werden.

REPOSITORY_NAME

Ein Webhook löst einen Build aus, wenn der Name des Repositorys dem Muster eines regulären Ausdrucks entspricht. Ein REPOSITORY_NAME Filter kann nur mit GitHub globalen oder organisatorischen Webhooks verwendet werden.

ORGANIZATION_NAME

Ein Webhook löst einen Build aus, wenn der Name der Organisation dem Muster eines regulären Ausdrucks entspricht. Ein ORGANIZATION_NAME Filter kann nur mit GitHub globalen Webhooks verwendet werden.

WORKFLOW_NAME

Ein Webhook löst einen Build aus, wenn der Workflow-Name mit dem Muster des regulären Ausdrucks übereinstimmt. Ein WORKFLOW_NAME Filter kann für Ereignisse in der Warteschlange von Aufträgen im GitHub Aktionsworkflow verwendet werden.

Anmerkung

Sie finden die Webhook-Payload in den Webhook-Einstellungen Ihres Repositorys. GitHub

Themen