Você pode usar grupos de filtros de webhook para especificar quais eventos de webhook do GitHub acionam uma compilação. Por exemplo, é possível especificar que uma compilação seja acionada somente para alterações em ramificações especificadas.
Você pode criar um ou mais grupos de filtros de webhook para especificar quais eventos de webhook acionam uma compilação. Uma compilação será acionada se algum grupo de filtros for avaliado como verdadeiro, o que ocorre quando todos os filtros no grupo são avaliados como verdadeiros. Ao criar um grupo de filtros, é necessário especificar:
- Um evento
-
Para o GitHub, você pode escolher um ou mais dos seguintes eventos:
PUSH
,PULL_REQUEST_CREATED
,PULL_REQUEST_UPDATED
,PULL_REQUEST_REOPENED
,PULL_REQUEST_MERGED
,PULL_REQUEST_CLOSED
,RELEASED
,PRERELEASED
eWORKFLOW_JOB_QUEUED
. O tipo de evento webhook está no cabeçalhoX-GitHub-Event
na carga webhook. No cabeçalhoX-GitHub-Event
, você pode verpull_request
oupush
. Para obter uma solicitação pull, o tipo de evento está no campoaction
da carga do evento webhook. A tabela a seguir mostra como valores de cabeçalhoX-GitHub-Event
e os valores do campoaction
da carga da solicitação pull webhook são mapeados para os tipos de eventos disponíveis.Valor do cabeçalho X-GitHub-Event
Valor action
da carga do evento WebhookTipo de evento pull_request
opened
PULL_REQUEST_CREATED
pull_request
reopened
PULL_REQUEST_REOPENED
pull_request
synchronize
PULL_REQUEST_UPDATED
pull_request
closed
e o campomerged
étrue
PULL_REQUEST_MERGED
pull_request
closed
e o campomerged
éfalse
PULL_REQUEST_CLOSED
push
n/a PUSH
release
lançado RELEASED
release
pré-lançado PRERELEASED
workflow_job
queued WORKFLOW_JOB_QUEUED
nota
O tipo de evento
PULL_REQUEST_REOPENED
pode ser usado apenas com o GitHub e o GitHub Enterprise Server. O tipo de eventoRELEASED
,PRERELEASED
eWORKFLOW_JOB_QUEUED
pode ser usado apenas com o GitHub. Para obter mais informações sobreWORKFLOW_JOB_QUEUED
, consulte Tutorial: configurar um executor do GitHub Actions hospedado pelo CodeBuild. - Um ou mais filtros opcionais
-
Use uma expressão regular para especificar um filtro. Para um evento acionar uma compilação, cada filtro do grupo associado a ele deve ser avaliado como verdadeiro.
ACTOR_ACCOUNT_ID
(ACTOR_ID
no console)-
Um evento de webhook aciona uma compilação quando um ID de conta do GitHub ou do GitHub Enterprise Server corresponde ao padrão da expressão regular. Esse valor é encontrado na propriedade
id
do objetosender
na carga webhook. HEAD_REF
-
Um evento de webhook aciona uma compilação quando a referência head corresponde ao padrão da expressão regular (por exemplo,
refs/heads/branch-name
ourefs/tags/tag-name
). Para um evento push, o nome de referência é encontrado na propriedaderef
da carga webhook. Para eventos de solicitações pull, o nome da ramificação é encontrado na propriedaderef
do objetohead
na carga webhook. BASE_REF
-
Um evento de webhook aciona uma compilação quando a referência base corresponde ao padrão da expressão regular (por exemplo,
refs/heads/branch-name
). Um filtroBASE_REF
pode ser usado apenas com eventos de solicitação pull. O nome da ramificação é encontrado na propriedaderef
do objetobase
na carga webhook. FILE_PATH
-
Um evento de webhook aciona uma compilação quando o caminho de um arquivo alterado corresponde ao padrão das expressões regulares. Um filtro
FILE_PATH
pode ser usado com eventos de solicitação push e pull do GitHub e eventos de push do GitHub Enterprise Server. Ele não pode ser usado com eventos de solicitação pull do GitHub Enterprise Server. COMMIT_MESSAGE
-
Um webhook aciona uma compilação quando a mensagem de confirmação head corresponde à expressão padrão. Um filtro
COMMIT_MESSAGE
pode ser usado com eventos de solicitação push e pull do GitHub e eventos de push do GitHub Enterprise Server. Ele não pode ser usado com eventos de solicitação pull do GitHub Enterprise Server. TAG_NAME
-
Um webhook aciona uma compilação quando o nome da tag da versão corresponde ao padrão de expressão regular. Um filtro
TAG_NAME
pode ser usado com eventos de solicitação lançados e pré-lançados do GitHub. RELEASE_NAME
-
Um webhook aciona uma compilação quando o nome da versão corresponde ao padrão da expressão regular. Um filtro
RELEASE_NAME
pode ser usado com eventos de solicitação lançados e pré-lançados do GitHub. REPOSITORY_NAME
-
Um webhook aciona uma compilação quando o nome do repositório corresponde ao padrão da expressão regular. Um filtro
REPOSITORY_NAME
só pode ser usado com webhooks globais ou organizacionais do GitHub. WORKFLOW_NAME
-
Um webhook aciona uma compilação quando o nome do fluxo de trabalho corresponde ao padrão da expressão regular. Um filtro
WORKFLOW_NAME
pode ser usado com eventos de solicitação em fila do trabalho do fluxo de trabalho do GitHub Actions.
nota
Você pode encontrar a carga webhook nas configurações de webhook no seu repositório do GitHub.