GitHub événements webhook - AWS CodeBuild

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

GitHub événements webhook

Vous pouvez utiliser des groupes de filtres Webhook pour spécifier quels événements GitHub Webhook déclenchent une compilation. Par exemple, vous pouvez spécifier qu'une construction n'est déclenchée que pour les modifications apportées à des branches spécifiques.

Vous pouvez créer un ou plusieurs des groupes de filtres webhook pour spécifier les événements webhook qui déclenchent une génération. Une génération est déclenchée si un groupe de filtres est évalué comme vrai, ce qui se produit lorsque tous les filtres du groupe sont évalués comme vrais. Lorsque vous créez un groupe de filtres, vous spécifiez :

Un événement

En GitHub effet, vous pouvez choisir un ou plusieurs des événements suivants : PUSHPULL_REQUEST_CREATED,PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENEDPULL_REQUEST_MERGED,PULL_REQUEST_CLOSED,RELEASED,PRERELEASED, etWORKFLOW_JOB_QUEUED. Le type d’événement du webhook est situé dans l’en-tête X-GitHub-Event de la charge utile du webhook. Dans l’en-tête X-GitHub-Event, vous pourriez voir pull_request ou push. Pour un événement de demande d’extraction, le type se situe dans le champ action de la charge utile d’événement du webhook. Le tableau suivant présente le mappage des valeurs de l’en-tête X-GitHub-Event et des valeurs du champ action de la charge utile de la demande d’extraction du webhook aux types d’événements disponibles.

Valeur d'en-tête X-GitHub-Event Valeur action de la charge utile de l’événement du webhook Type d’événement
pull_request opened PULL_REQUEST_CREATED
pull_request reopened PULL_REQUEST_REOPENED
pull_request synchronize PULL_REQUEST_UPDATED
pull_request closed et le champ merged est true PULL_REQUEST_MERGED
pull_request closed et le champ merged est false PULL_REQUEST_CLOSED
push N/A PUSH
release publié RELEASED
release pré-publié PRERELEASED
workflow_job queued WORKFLOW_JOB_QUEUED
Note

Le type d'PULL_REQUEST_REOPENEDévénement ne peut être utilisé qu'avec un GitHub serveur GitHub d'entreprise. Le type PRERELEASED d'événement RELEASED et ne peut être utilisé GitHub qu'avec. Pour plus d'informations sur WORKFLOW_JOB_QUEUED, consultez Tutoriel : Configuration d'un CodeBuild exécuteur d' GitHubactions hébergé.

Un ou plusieurs filtres optionnels

Utilisez une expression régulière pour spécifier un filtre. Pour qu'un événement déclenche une génération, chaque filtre du groupe qui lui est associé doit avoir la valeur true.

ACTOR_ACCOUNT_ID(ACTOR_IDdans la console)

Un événement webhook déclenche une compilation lorsqu'un identifiant de compte GitHub ou un identifiant de compte GitHub Enterprise Server correspond au modèle d'expression régulière. Cette valeur se situe dans la propriété id de l’objet sender dans la charge utile du webhook.

HEAD_REF

Un événement webhook déclenche une construction lorsque la référence principale correspond au modèle d'expression régulière (par exemple, refs/heads/branch-name ourefs/tags/tag-name). Pour un événement d’extraction, le nom de référence est situé dans la propriété ref de la charge utile du webhook. Pour les événements de demande d’extraction, le nom de la branche est situé dans la propriété ref de l’objet head dans la charge utile du webhook.

BASE_REF

Un événement webhook déclenche une construction lorsque la référence de base correspond au modèle d'expression régulière (par exemple,refs/heads/branch-name). Un filtre BASE_REF ne peut être utilisé qu’avec des événements de demande d’extraction. Le nom de la branche se situe dans la propriété ref de l’objet base dans la charge utile du webhook.

FILE_PATH

Un webhook déclenche une compilation lorsque le chemin d'un fichier modifié correspond au modèle d'expressions régulières. Un FILE_PATH filtre peut être utilisé avec les événements de requêtes GitHub push et pull et les événements push GitHub d'Enterprise Server. Il ne peut pas être utilisé avec les événements de pull request d' GitHubEnterprise Server.

COMMIT_MESSAGE

Un webhook déclenche une compilation lorsque le message de validation principal correspond au modèle d'expression régulière. Un COMMIT_MESSAGE filtre peut être utilisé avec les événements de requêtes GitHub push et pull et les événements push GitHub d'Enterprise Server. Il ne peut pas être utilisé avec les événements de pull request d' GitHubEnterprise Server.

TAG_NAME

Un webhook déclenche une compilation lorsque le nom de balise de la version correspond au modèle d'expression régulière. Un TAG_NAME filtre peut être utilisé avec les événements de demande GitHub publiés et prépubliés.

RELEASE_NAME

Un webhook déclenche une compilation lorsque le nom de la version correspond au modèle d'expression régulière. Un RELEASE_NAME filtre peut être utilisé avec les événements de demande GitHub publiés et prépubliés.

REPOSITORY_NAME

Un webhook déclenche une compilation lorsque le nom du dépôt correspond au modèle d'expression régulière. Un REPOSITORY_NAME filtre ne peut être utilisé qu'avec des webhooks GitHub globaux ou organisationnels.

ORGANIZATION_NAME

Un webhook déclenche une compilation lorsque le nom de l'organisation correspond au modèle d'expression régulière. Un ORGANIZATION_NAME filtre ne peut être utilisé qu'avec des webhooks GitHub globaux.

WORKFLOW_NAME

Un webhook déclenche une compilation lorsque le nom du flux de travail correspond au modèle d'expression régulière. Un WORKFLOW_NAME filtre peut être utilisé avec les événements de demande de travail en file d'attente du flux de travail GitHub Actions.

Note

Vous pouvez trouver la charge utile du webhook dans les paramètres du webhook de votre dépôt. GitHub

Rubriques