Eventos que disparam fluxos de trabalho

Sobre eventos que acionam fluxos de trabalho

Os acionadores de fluxo de trabalho são eventos que fazem com que um fluxo de trabalho seja executado. Para obter mais informações sobre como usar gatilhos de fluxo de trabalho, confira Acionando um fluxo de trabalho.

Alguns eventos têm vários tipos de atividades. Para esses eventos, você pode especificar quais tipos de atividade ativarão a execução de um fluxo de trabalho. Para obter mais informações sobre o que significa cada tipo de atividade, confira Eventos e cargas de webhook.

Assim como os fluxos de trabalho GitHub Actions, agentic workflows podem ser disparados por eventos do repositório e agendamentos. Para ver um exemplo, confira Criando fluxos de trabalho agênticos do GitHub.

branch_protection_rule

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
branch_protection_rule	- created - edited - deleted	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando as regras de proteção de branch no repositório do fluxo de trabalho são alteradas. Para obter mais informações sobre as regras de proteção do branch, confira Sobre branches protegidos. Para obter informações sobre as APIs da regra de proteção de ramificação, confira Branches" na documentação da API do GraphQL ou Pontos de extremidade da API REST para ramificações e suas configurações.

Por exemplo, você poderá executar um fluxo de trabalho quando uma regra de proteção de branch for created ou deleted:

on:
  branch_protection_rule:
    types: [created, deleted]

check_run

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
check_run	- created - rerequested - completed - requested_action	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando ocorre a atividade relacionada a uma execução de verificação. Uma execução de verificação é um teste individual que faz parte de um conjunto de verificações. Para obter mais informações, confira Como usar a API REST para interagir com verificações. Para obter informações sobre as APIs de execução de verificação, confira Verificações na documentação da API do GraphQL ou Pontos de extremidade da API REST para execuções de verificação."

Por exemplo, você poderá executar um fluxo de trabalho quando uma execução de verificação for rerequested ou completed.

on:
  check_run:
    types: [rerequested, completed]

check_suite

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
check_suite	- completed	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando ocorre a atividade do conjunto de verificações. Um conjunto de verificações é uma coleção das execuções de verificação criadas para um commit específico. O conjunto de verificações resumem o status e a conclusão das execuções de verificação que estão no conjunto. Para obter mais informações, confira Como usar a API REST para interagir com verificações. Para obter informações sobre as APIs do conjunto de verificação, confira Verificações na documentação da API do GraphQL ou Endpoints da API REST para conjuntos de verificações.

Por exemplo, você poderá executar um fluxo de trabalho quando um conjunto de verificações for completed.

on:
  check_suite:
    types: [completed]

create

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
create	Não aplicável	Último commit no branch ou tag criado	Branch ou tag criado

Executa o fluxo de trabalho quando alguém cria uma referência Git (branch ou tag) no repositório do fluxo de trabalho. Para obter informações sobre as APIs usadas para criar uma referência Git, confira Git na documentação da API do GraphQL ou Pontos de extremidade da API REST para referências Git.

Por exemplo, você poderá executar um fluxo de trabalho quando o evento create ocorrer.

on:
  create

delete

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
delete	Não aplicável	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando alguém exclui uma referência Git (branch ou tag) no repositório do fluxo de trabalho. Para obter informações sobre as APIs usadas para excluir uma referência do Git, confira Git na documentação da API do GraphQL ou Pontos de extremidade da API REST para referências Git.

Por exemplo, você poderá executar um fluxo de trabalho quando o evento delete ocorrer.

on:
  delete

deployment

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
deployment	Não aplicável	Commit a ser implantado	Branch ou tag a ser implantado (vazio, se criado com o SHA de um commit)

Executa o fluxo de trabalho quando alguém cria uma implantação no repositório do fluxo de trabalho. As implantações criadas com um SHA de commit podem não ter uma referência do Git. Para obter informações sobre as APIs usadas para criar uma implantação, confira Deployments na documentação da API do GraphQL ou Pontos de extremidade da API REST para repositórios.

Por exemplo, você poderá executar um fluxo de trabalho quando o evento deployment ocorrer.

on:
  deployment

deployment_status

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
deployment_status	Não aplicável	Commit a ser implantado	Branch ou tag a ser implantado (vazio se commit)

Executa o fluxo de trabalho quando uma terceira parte fornece um status de implantação. As implantações criadas com um SHA de commit podem não ter uma referência do Git. Para obter informações sobre as APIs usadas para criar um status de implantação, confira Deployments na documentação da API do GraphQL ou Pontos de extremidade da API REST para implantações.

Por exemplo, você poderá executar um fluxo de trabalho quando o evento deployment_status ocorrer.

on:
  deployment_status

discussion

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
discussion	- created - edited - deleted - transferred - pinned - unpinned - labeled - unlabeled - locked - unlocked - category_changed - answered - unanswered	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando uma discussão no repositório do fluxo de trabalho é criada ou modificada. Para as atividades relacionadas a comentários sobre uma discussão, use o evento discussion_comment. Para obter mais informações sobre discussões, confira Sobre discussões. Para obter informações sobre a API do GraphQL, confira Discussões.

Por exemplo, você poderá executar um fluxo de trabalho quando uma discussão for created, edited ou answered.

on:
  discussion:
    types: [created, edited, answered]

discussion_comment

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
discussion_comment	- created - edited - deleted	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando um comentário em uma discussão no repositório do fluxo de trabalho é criado ou modificado. Para as atividades relacionadas a uma discussão em vez de comentários sobre uma discussão, use o evento discussion. Para obter mais informações sobre discussões, confira Sobre discussões. Para obter informações sobre a API do GraphQL, confira Discussões.

Por exemplo, você poderá executar um fluxo de trabalho quando um comentário de discussão for created ou deleted.

on:
  discussion_comment:
    types: [created, deleted]

fork

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
fork	Não aplicável	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando alguém bifurca um repositório. Para obter informações sobre a API REST, confira Pontos de extremidade de API REST para forks.

Por exemplo, você poderá executar um fluxo de trabalho quando o evento fork ocorrer.

on:
  fork

gollum

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
gollum	Não aplicável	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando alguém cria ou atualiza uma página wiki. Para obter mais informações, confira Sobre wikis.

Por exemplo, você poderá executar um fluxo de trabalho quando o evento gollum ocorrer.

on:
  gollum

image_version

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
Não aplicável	Não aplicável	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando uma nova versão de uma imagem especificada fica disponível para uso. Esse evento normalmente é disparado após uma criação bem-sucedida da versão da imagem, permitindo que você automatize ações como implantação ou notificações em resposta a novas versões de imagem.

Este evento oferece suporte a padrões globais para nomes e versões de imagem. O exemplo a seguir dispara quando uma nova versão de imagem corresponde a qualquer uma das combinações de nome e versão especificadas. Por exemplo, ["MyNewImage", 1.0.0], ["MyNewImage", 2.53.0], ["MyOtherImage", 1.0.0]e ["MyOtherImage", 2.0.0].

on:
  image_version:
    names:
    - "MyNewImage"
    - "MyOtherImage"
    versions:
    - 1.*
    - 2.*

issue_comment

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
issue_comment	- created - edited - deleted	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando um problema ou comentário de pull request é criado, editado ou excluído. Para obter informações sobre as APIs de comentários de problemas, confira Problemas na documentação da API do GraphQL ou Eventos e cargas de webhook na documentação da API REST.

Por exemplo, você poderá executar um fluxo de trabalho quando um comentário ou um problema de uma solicitação de pull for created ou deleted.

on:
  issue_comment:
    types: [created, deleted]

issue_comment apenas em problemas ou em solicitações de pull

O evento issue_comment ocorre em comentários sobre problemas e solicitações de pull. Você pode usar a propriedade github.event.issue.pull_request em um condicional para realizar uma ação diferente, dependendo se o objeto de gatilho foi um problema ou uma solicitação de pull.

Por exemplo, esse fluxo de trabalho executará o trabalho pr_commented somente se o evento issue_comment for originado de uma solicitação de pull. Ele executará o trabalho issue_commented somente se o evento issue_comment tiver se originado de um problema.

on: issue_comment

jobs:
  pr_commented:
    # This job only runs for pull request comments
    name: PR comment
    if: ${{ github.event.issue.pull_request }}
    runs-on: ubuntu-latest
    steps:
      - run: |
          echo A comment on PR $NUMBER
        env:
          NUMBER: ${{ github.event.issue.number }}

  issue_commented:
    # This job only runs for issue comments
    name: Issue comment
    if: ${{ !github.event.issue.pull_request }}
    runs-on: ubuntu-latest
    steps:
      - run: |
          echo A comment on issue $NUMBER
        env:
          NUMBER: ${{ github.event.issue.number }}

issues

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
issues	- opened - edited - deleted - transferred - pinned - unpinned - closed - reopened - assigned - unassigned - labeled - unlabeled - locked - unlocked - milestoned - demilestoned - typed - untyped - field_added - field_removed	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando um problema no repositório do fluxo de trabalho é criado ou modificado. Para as atividades relacionadas a comentários em um problema, use o evento issue_comment. Para obter mais informações sobre problemas, confira Sobre problemas. Para obter informações sobre as APIs de problemas, confira Problemas na documentação da API do GraphQL ou Pontos de extremidade da API REST para issues.

Por exemplo, você poderá executar um fluxo de trabalho quando um problema for opened, edited ou milestoned.

on:
  issues:
    types: [opened, edited, milestoned]

Você também pode executar um fluxo de trabalho quando um valor de campo de problema é definido, alterado ou desmarcado. O field_added tipo de atividade é acionado quando um valor de campo é inicialmente definido e quando um valor existente é atualizado. O tipo de atividade field_removed é disparado quando um valor de campo é apagado.

on:
  issues:
    types: [field_added, field_removed]

label

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
label	- created - edited - deleted	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando uma etiqueta no repositório do fluxo de trabalho é criada ou modificada. Para obter mais informações sobre rótulos, confira Gerenciar etiquetas. Para obter informações sobre as APIs de rótulo, confira "Problemas na documentação da API do GraphQL ou Pontos de extremidade da API REST para rótulos.

Caso deseje executar seu fluxo de trabalho quando um rótulo for adicionado ou removido de um problema, solicitação de pull ou discussão, use os tipos de atividade labeled ou unlabeled para os eventos issues, pull_request, pull_request_target, ou discussion, no lugar.

Por exemplo, você poderá executar um fluxo de trabalho quando um rótulo for created ou deleted.

on:
  label:
    types: [created, deleted]

merge_group

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
merge_group	checks_requested	SHA do grupo de mesclagem	Referência do grupo de mesclagem

Mais de um tipo de atividade aciona este evento. Embora haja suporte apenas para o checks_requested tipo de atividade, especificar o tipo de atividade manterá seu fluxo de trabalho específico se mais tipos de atividade forem adicionados no futuro. Para obter informações sobre cada tipo de atividade, confira Eventos e cargas de webhook. Por padrão, todos os tipos de atividade disparam fluxos de trabalho que são executados nesse evento. Você pode limitar suas execuções de fluxo de trabalho a tipos de atividades específicos usando a palavra-chave types. Para saber mais, confira Sintaxe de fluxo de trabalho para o GitHub Actions.

• Se o seu repositório usa o GitHub Actions para realizar verificações necessárias ou se você exige fluxos de trabalho por meio de conjuntos de regras da organização em solicitações pull em seu repositório, é necessário atualizar os fluxos de trabalho para incluir o evento merge_group como um gatilho adicional. Caso contrário, as verificações de status não serão disparadas quando você adicionar uma solicitação de pull a uma fila de mesclagem. A mesclagem falhará, pois o verificação de status obrigatória não será relatada. O evento merge_group é separado dos eventos pull_request e push.

Executa o fluxo de trabalho quando uma solicitação de pull é adicionada a uma fila de mesclagem, o que adiciona a solicitação de pull a um grupo de mesclagem. Para obter mais informações, confira Como mesclar uma pull request com uma fila de mesclagem.

Por exemplo, você poderá executar um fluxo de trabalho quando a atividade checks_requested tiver ocorrido.

on:
  pull_request:
    branches: [ "main" ]
  merge_group:
    types: [checks_requested]

milestone

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
milestone	- created - closed - opened - edited - deleted	Último commit no branch padrão	Branch padrão

Executa o fluxo de trabalho quando um marco no repositório do fluxo de trabalho é criado ou modificado. Para obter mais informações sobre marcos, confira Sobre marcos. Para obter informações sobre as APIs de marcos, confira Problemas na documentação da API do GraphQL ou Pontos de extremidade da API REST para marcos.

Caso deseje executar seu fluxo de trabalho quando um problema for adicionado ou removido de um marco, use os tipos de atividade milestoned ou demilestoned para o evento issues no lugar.

Por exemplo, você poderá executar um fluxo de trabalho quando um marco for opened ou deleted.

on:
  milestone:
    types: [opened, deleted]

page_build

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF
page_build	Não aplicável	Último commit no branch padrão	Branch padrão

Executa seu fluxo de trabalho quando alguém faz um push em um branch que é a origem da publicação para o GitHub Pages, se o GitHub Pages estiver habilitado para o repositório. Para obter mais informações sobre GitHub Pages fontes de publicação, consulte Configurando uma fonte de publicação para seu site GitHub Pages. Para obter informações sobre a API REST, confira Pontos de extremidade da API REST para repositórios.

Por exemplo, você poderá executar um fluxo de trabalho quando o evento page_build ocorrer.

on:
  page_build

public

Carga de evento webhook	Tipos de Atividade	GITHUB_SHA	GITHUB_REF