GitHub eventi webhook

È possibile utilizzare i gruppi di filtri webhook per specificare quali eventi GitHub webhook attivano una build. Ad esempio, è possibile specificare che una build venga attivata solo per le modifiche a rami specifici.

È possibile creare uno o più gruppi di filtri di webhook per specificare quali eventi webhook attivano una compilazione. Una build viene attivata se un gruppo di filtri restituisce true, il che si verifica quando tutti i filtri del gruppo restituiscono true. Al momento della creazione di un gruppo di filtri sarà necessario indicare:

Un evento

Infatti GitHub, puoi scegliere uno o più dei seguenti eventi:PUSH,PULL_REQUEST_CREATED,PULL_REQUEST_UPDATED,PULL_REQUEST_REOPENED,PULL_REQUEST_MERGED, PULL_REQUEST_CLOSEDRELEASED,PRERELEASED, eWORKFLOW_JOB_QUEUED. Il tipo di evento webhook si trova nell'intestazione X-GitHub-Event nel payload del webhook. Nell'intestazione X-GitHub-Event puoi vedere pull_request o push. Per un evento di richiesta pull, il tipo si trova nel campo action del payload del webhook. La tabella seguente mostra il modo in cui i valori dell'intestazione X-GitHub-Event e i valori del campo action del payload della richiesta pull del webhook sono mappati ai tipi di eventi disponibili.

Valore intestazione X-GitHub-Event	Valore action del payload di eventi webhook	Tipo di evento
pull_request	opened	PULL_REQUEST_CREATED
pull_request	reopened	PULL_REQUEST_REOPENED
pull_request	synchronize	PULL_REQUEST_UPDATED
pull_request	closede il campo merged è true	PULL_REQUEST_MERGED
pull_request	closede il campo merged è false	PULL_REQUEST_CLOSED
push	N/A	PUSH
release	rilasciato	RELEASED
release	prerelasciato	PRERELEASED
workflow_job	queued	WORKFLOW_JOB_QUEUED

Nota

Il tipo di PULL_REQUEST_REOPENED evento può essere utilizzato solo con GitHub Enterprise GitHub Server. Il tipo di PRERELEASED evento RELEASED and può essere utilizzato GitHub solo con. Per ulteriori informazioni su WORKFLOW_JOB_QUEUED, consulta Tutorial: configura un GitHub Actions CodeBuild runner ospitato.

Uno o più filtri opzionali

Per specificare un filtro, utilizza un'espressione regolare. Affinché un evento attivi una build, ogni filtro all'interno del gruppo ad esso associato deve restituire true.

ACTOR_ACCOUNT_ID(ACTOR_IDnella console)

Un evento webhook attiva una build quando l'ID di un account GitHub o di GitHub Enterprise Server corrisponde al modello di espressione regolare. Questo valore si trova nella proprietà id dell'oggetto sender nel payload del webhook.

HEAD_REF

Un evento webhook attiva una build quando il riferimento alla testina corrisponde al modello di espressione regolare (ad esempio, o). refs/heads/branch-name refs/tags/tag-name Per un evento push, il nome di riferimento si trova nella proprietà ref nel payload del webhook. Per gli eventi di richieste pull, il nome del ramo si trova nella proprietà ref dell'oggetto head nel payload del webhook.

BASE_REF

Un evento webhook attiva una build quando il riferimento di base corrisponde al modello di espressione regolare (ad esempio,). refs/heads/branch-name Un filtro BASE_REF può essere utilizzato solo con gli eventi di richiesta pull. Il nome del ramo si trova nella proprietà ref dell'oggetto base nel payload del webhook.

FILE_PATH

Un webhook attiva una build quando il percorso di un file modificato corrisponde al modello delle espressioni regolari. Un FILE_PATH filtro può essere utilizzato con gli eventi di richiesta GitHub push e pull e gli eventi push di GitHub Enterprise Server. Non può essere utilizzato con gli eventi di pull request di GitHub Enterprise Server.

COMMIT_MESSAGE

Un webhook attiva una build quando il messaggio head commit corrisponde al modello di espressione regolare. Un COMMIT_MESSAGE filtro può essere utilizzato con gli eventi di richiesta GitHub push e pull e gli eventi push di GitHub Enterprise Server. Non può essere utilizzato con gli eventi di pull request di GitHub Enterprise Server.

TAG_NAME

Un webhook attiva una build quando il nome del tag della release corrisponde al modello di espressione regolare. È possibile utilizzare un TAG_NAME filtro con eventi di richiesta GitHub rilasciati e non rilasciati in anteprima.

RELEASE_NAME

Un webhook attiva una build quando il nome della release corrisponde al modello di espressione regolare. È possibile utilizzare un RELEASE_NAME filtro con eventi di richiesta GitHub rilasciati e non rilasciati in anteprima.

REPOSITORY_NAME

Un webhook attiva una build quando il nome del repository corrisponde al modello di espressione regolare. Un REPOSITORY_NAME filtro può essere utilizzato solo con webhook GitHub globali o organizzativi.

ORGANIZATION_NAME

Un webhook attiva una build quando il nome dell'organizzazione corrisponde al modello di espressione regolare. Un ORGANIZATION_NAME filtro può essere utilizzato solo con webhook GitHub globali.

WORKFLOW_NAME

Un webhook attiva una build quando il nome del flusso di lavoro corrisponde al modello di espressione regolare. È possibile utilizzare un WORKFLOW_NAME filtro con gli eventi di richiesta di lavoro in coda del flusso di lavoro di GitHub Actions.

Nota

Puoi trovare il payload del webhook nelle impostazioni del webhook del tuo repository. GitHub

Argomenti

• Filtra gli eventi GitHub webhook (console)

• Filtra gli eventi GitHub webhook (SDK)

• Filtra gli eventi GitHub webhook ()AWS CloudFormation