Skip to main content

Eventos que acionam fluxos de trabalho

É possível configurar a execução de seus fluxos de trabalho quando uma atividade específica acontece no GitHub em um período agendado ou quando ocorre um evento externo do GitHub.

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 os gatilhos de fluxo de trabalho, consulte "Acionando um fluxo de trabalho".

Eventos disponíveis

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 significado de cada tipo de atividade, consulte "Eventos de webhook e cargas". Observe que nem todos os eventos de webhook acionam fluxos de trabalho.

branch_protection_rule

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
branch_protection_rule- created
- edited
- deleted
Último commit no branch padrãoBranch padrão

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas." Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no 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 de branches, consulte "Sobre branches protegidos". Para informações sobre as APIs das regras de proteção de branch, consulte "BranchProtectionRule" na documentação da API do GraphQL ou "Branches" na documentação da API REST.

Por exemplo, você pode executar um fluxo de trabalho quando uma regra de proteção de branch tiver sido criada ou excluída:

on:
  branch_protection_rule:
    types: [created, deleted]

check_run

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
check_run- created
- rerequested
- completed
-requested_action
Último commit no branch padrãoBranch padrão

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no 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 informações, consulte "Primeiros passos com a API de Verificações". Para informações sobre as APIs de verificação, consulte "CheckRun" na documentação da API do GraphQL ou "Verificações" na documentação da API REST.

Por exemplo, você pode executar um fluxo de trabalho quando uma execução de verificação tiver sido rerequested ou completed.

on:
  check_run:
    types: [rerequested, completed]

check_suite

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
check_suite- completedÚltimo commit no branch padrãoBranch padrão

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Embora apenas o tipo de atividade iniciado seja compatível, especificar o tipo de atividade manterá o fluxo de trabalho específico se mais tipos de atividade forem adicionados posteriormente. Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Observação: Para evitar fluxos de trabalho recursivos, este evento não aciona fluxos de trabalho se o conjunto de verificação foi criado por GitHub Actions.

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 informações, consulte "Primeiros passos com a API de Verificações". Para obter informações sobre as APIs de Verificação, consulte "CheckSuite" na documentação da API do GraphQL ou "Verificações" na documentação da API REST.

Por exemplo, você pode executar um fluxo de trabalho quando um conjunto de verificações tiver sido concluído.

on:
  check_suite:
    types: [completed]

create

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
createn/aÚltimo commit no branch ou tag criadoBranch ou tag criado

Observação: Um evento não será criado quando você criar mais de três tags de uma só vez.

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 APIs para criar uma referência do Git, consulte "createRef" na documentação da API do GraphQL ou "Criar uma referência" na documentação da API REST.

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

on:
  create

delete

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
deleten/aÚltimo commit no branch padrãoBranch padrão

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Observação: Um evento não será criado quando você excluir mais de três tags de uma só vez.

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 para excluir uma referência do Git, consulte "deleteRef" na documentação da API do GraphQL ou "Excluir uma referência" na documentação da API REST.

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

on:
  delete

implantação

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
implantaçãon/aCommit a ser implantadoBranch 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. Implantações criadas com um commit SHA podem não ter um Git ref. Para obter informações sobre as APIs para criar uma implantação, consulte "createDeploymen" na documentação da API do GraphQL ou "Implantações" na documentação da API REST.

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

on:
  deployment

implantação_status

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
implantação_statusn/aCommit a ser implantadoBranch ou tag a ser implantado (vazio se commit)

Observação: Quando o estado de um estado de implantação está definido como inativo, a execução de um fluxo de trabalho não será acionada.

Executa o fluxo de trabalho quando uma terceira parte fornece um status de implantação. Implantações criadas com um commit SHA podem não ter um Git ref. Para informações sobre as APIs para criar um status de implantação, consulte "createDeploymentStatus" na documentação da API do GraphQL ou "Criar um status de implantação" na documentação da API REST.

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

on:
  deployment_status

discussão

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
discussão- created
- edited
- deleted
- transferred
- pinned
- unpinned
- labeled
- unlabeled
- locked
- unlocked
- category_changed
- answered
- unanswered
Último commit no branch padrãoBranch padrão

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

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

Por exemplo, você pode executar um fluxo de trabalho quando uma discussão tiver sido created, edited ou answered.

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

discussion_comment

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
discussion_comment- created
- edited
- deleted
Último commit no branch padrãoBranch padrão

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas." Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Note: Webhook events for GitHub Discussions are currently in beta and subject to change.

Executa o fluxo de trabalho quando um comentário em uma discussão no repositório do fluxo de trabalho é criado ou modificado. Para atividade relacionada a uma discussão, ao contrário de comentários na discussão, use o evento discussão. Para obter mais informações sobre discussões, consulte "Sobre discussões. " Para obter informações sobre a API do GraphQL, consulte "Discussão".

Por exemplo, você pode executar um fluxo de trabalho quando um comentário de discussão tiver sido criado ou excluído.

on:
  discussion_comment:
    types: [created, deleted]

bifurcação

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
bifurcaçãon/aÚltimo commit no branch padrãoBranch padrão

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Executa o fluxo de trabalho quando alguém bifurca um repositório. Para obter informações sobre a API REST, consulte "Criar uma bifurcação".

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

on:
  fork

gollum

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
gollumn/aÚltimo commit no branch padrãoBranch padrão

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

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

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

on:
  gollum

issue_comment

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
issue_comment- created
- edited
- deleted
Último commit no branch padrãoBranch padrão

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Executa o fluxo de trabalho quando um problema ou comentário de pull request é criado, editado ou excluído. Para informação sobre as APIs de comentário de problema, consulte "IssueComment" na documentação da API do GraphQL ou "Comentários do problema" na documentação da API REST.

Por exemplo, você pode executar um fluxo de trabalho quando um problema ou comentário de pull request tiver sido criado `ouexcluído`.

on:
  issue_comment:
    types: [created, deleted]

issue_comment apenas em problemas ou pull requests

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

Por exemplo, este fluxo de trabalho irá executar o trabalho pr_commented apenas se o evento issue_comment teve origem em um pull request. Será executado o trabalho issue_commented somente se o evento issue_comment originar 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 }}

Problemas

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
Problemas- opened
- edited
- deleted
- transferred
- pinned
- unpinned
- closed
- reopened
- assigned
- unassigned
- labeled
- unlabeled
- locked
- unlocked
- milestoned
- demilestoned
Último commit no branch padrãoBranch padrão

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas." Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Executa o fluxo de trabalho quando um problema no repositório do fluxo de trabalho é criado ou modificado. Para atividade relacionada a comentários em uma issue, use o evento issue_comment. Para obter mais informações sobre os problemas, consulte "Sobre os problemas". Para informações sobre as APIs do problema, consulte "Problema" na documentação da API do GraphQL ou "Problemas" na documentação da API REST.

Por exemplo, você pode executar um fluxo de trabalho quando um comentário tiver sido opened, edited ou milestoned.

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

etiqueta

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
etiqueta- created
- edited
- deleted
Último commit no branch padrãoBranch padrão

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no 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 etiquetas, consulte "Gerenciar etiquetas". Para obter informações sobre a API da etiqueta, consulte "Etiqueta" na documentação da API do GraphQL ou "Etiquetas" na documentação da API REST.

If you want to run your workflow when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled activity types for the issues, pull_request, pull_request_target, or discussion events instead.

Por exemplo, você pode executar um fluxo de trabalho quando uma etiqueta tiver sido created ou deleted.

on:
  label:
    types: [created, deleted]

marco

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
marco- created
- closed
- opened
- edited
- deleted
Último commit no branch padrãoBranch padrão

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas." Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no 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, consulte "Sobre marcos". Para informações sobre as APIs do marco, consulte "Marco" na documentação da API do GraphQL ou "Marcos" na documentação da API REST.

If you want to run your workflow when an issue is added to or removed from a milestone, use the milestoned or demilestoned activity types for the issues event instead.

Por exemplo, você pode executar um fluxo de trabalho quando um marco tiver sido aberto ou apagado.

on:
  milestone:
    types: [opened, deleted]

page_build

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
page_buildn/aÚltimo commit no branch padrãon/a

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Executa o fluxo de trabalho quando alguém faz push em um branch que é a fonte de publicação para GitHub Pages, se o GitHub Pages estiver habilitado no repositório. Para obter mais informações sobre fontes de publicação GitHub Pages, consulte "Configurando uma fonte de publicação para o site do GitHub Pages". Para obter informações sobre a API REST, consulte "Páginas".

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

on:
  page_build

project

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
project- created
- closed
- reopened
- edited
- deleted
Último commit no branch padrãoBranch padrão

Observação: Mais de um tipo de atividade aciona este evento. O tipo de atividade editado refere-se a quando um quadro de projeto, não é uma coluna ou um cartão no quadro de projeto, é editado. Para obter informações sobre cada tipo de atividade, consulte "Eventos Webhook e cargas". Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Observação: Este evento ocorre apenas para projetos pertencentes ao repositório do fluxo de trabalho, não é para projetos pertencentes à organização ou de propriedade de usuários ou para projetos pertencentes a outro repositório.

Observação: Este evento não ocorre para projetos (beta). Para obter mais informações, consulte "Sobre projetos (beta)".

Executa o fluxo de trabalho quando um quadro de projeto é criado ou modificado. For activity related to cards or columns in a project board, use the project_card or project_column events instead. Para obter mais informações sobre os quadros de projeto, consulte "Sobre quadros de projeto". Para informações sobre as APIs do quadro de projeto, consulte " Projeto" na documentação da API GraphQL ou "Projetos" na documentação da API REST.

Por exemplo, você pode executar um fluxo de trabalho quando um projeto tiver sido created ou deleted.

on:
  project:
    types: [created, deleted]

project_card

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
project_card- created
- moved
- converted to an issue
- edited
- deleted
Último commit no branch padrãoBranch padrão

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas." Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Observação: Este evento ocorre apenas para projetos pertencentes ao repositório do fluxo de trabalho, não é para projetos pertencentes à organização ou de propriedade de usuários ou para projetos pertencentes a outro repositório.

Observação: Este evento não ocorre para projetos (beta). Para obter mais informações, consulte "Sobre projetos (beta)".

Executa o fluxo de trabalho quando um cartão em um quadro de projeto é criado ou modificado. Para atividade relacionada aos quadros ou colunas do projeto em um quadro de projeto, use o evento projeto ou projeto_column. Para obter mais informações sobre os quadros de projeto, consulte "Sobre quadros de projeto". Para obter informações sobre as APIs de cartão do projeto, consulte "ProjectCard" na documentação da API do GraphQL ou "Cartões de projeto" na documentação da API REST.

Por exemplo, você pode executar um fluxo de trabalho quando um cartão de projeto tiver sido aberto ou excluído.

on:
  project_card:
    types: [created, deleted]

project_column

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
project_column- created
- updated
- moved
- deleted
Último commit no branch padrãoBranch padrão

Nota: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Observação: Este evento ocorre apenas para projetos pertencentes ao repositório do fluxo de trabalho, não é para projetos pertencentes à organização ou de propriedade de usuários ou para projetos pertencentes a outro repositório.

Observação: Este evento não ocorre para projetos (beta). Para obter mais informações, consulte "Sobre projetos (beta)".

Executa o fluxo de trabalho quando uma coluna em um quadro de projeto é criada ou modificada. Para a atividade relacionada a quadros de projetos ou cartões em um quadro de projeto, use o evento projeto ou project_card. Para obter mais informações sobre os quadros de projeto, consulte "Sobre quadros de projeto". Para obter informações sobre a coluna API do projeto, consulte "Coluna do Projeto" na Documentação da API do GraphQL ou "Colunas do Projeto" na documentação da API REST.

Por exemplo, você pode executar um fluxo de trabalho quando uma coluna de projeto tiver sido created ou deleted.

on:
  project_column:
    types: [created, deleted]

público

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
públicon/aÚltimo commit no branch padrãoBranch padrão

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Executa o fluxo de trabalho quando o repositório do fluxo de trabalho é alterado de privado para público. Para obter informações sobre a API REST, consulte "Editar repositórios".

Por exemplo, você pode executar um fluxo de trabalho quando o evento public ocorrer.

on:
  public

pull_request

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
pull_request- assigned
- unassigned
- labeled
- unlabeled
- opened
- edited
- closed
- reopened
- synchronize
- converted_to_draft
- ready_for_review
- locked
- unlocked
- review_requested
- review_request_removed
- auto_merge_enabled
- auto_merge_disabled
Último commit de merge no branch GITHUB_REFBranch de merge da PR refs/pull/:prNumber/merge

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Por padrão, um fluxo de trabalho só é executado quando um tipo de atividade de um evento de pull_request é opened,, sincronize ou reopened. Você pode especificar diferentes tipos de atividade usando a palavra chave tipos. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Note: By default, only the opened, synchronize, and reopened activity types trigger workflows that run on the pull_request event. Para acionar fluxos de trabalho em diferentes tipos de atividade, use a palavra-chave tipos.

Observação: Os fluxos de trabalho não serão executados na atividade pull_request se o pull request tiver um conflito de merge. O conflito de merge tem de ser resolvido primeiro.

Inversamente, os fluxos de trabalho com o evento pull_request_target serão executado mesmo se o pull request tiver um conflito de merge. Antes de usar o acionamento de pull_request_target, você deve estar ciente dos riscos de segurança. Para obter mais informações, consulte pull_request_target.

Executa o fluxo de trabalho quando ocorre uma atividade em no pull request no repositório do fluxo de trabalho. Por exemplo, se nenhum tipo de atividade for especificado, o fluxo de trabalho será executado quando um pull request é abertp ou reabertp ou quando o branch principal do pull request é atualizado. For activity related to pull request reviews, pull request review comments, or pull request comments, use the pull_request_review, pull_request_review_comment, or issue_comment events instead. For information about the pull request APIs, see "PullRequest" in the GraphQL API documentation or "Pull requests" in the REST API documentation.

Note that GITHUB_SHA for this event is the last merge commit of the pull request merge branch. If you want to get the commit ID for the last commit to the head branch of the pull request, use github.event.pull_request.head.sha instead.

For example, you can run a workflow when a pull request has been opened or reopened.

on:
  pull_request:
    types: [opened, reopened]

Você pode usar o contexto do evento para controlar ainda mais quando os trabalhos no seu fluxo de trabalho serão executados. For example, this workflow will run when a review is requested on a pull request, but the specific_review_requested job will only run when a review by octo-team is requested.

on:
  pull_request:
    types: [review_requested]
jobs:
  specific_review_requested:
    runs-on: ubuntu-latest
    if: ${{ github.event.requested_team.name == 'octo-team'}}
    steps:
      - run: echo 'A review from octo-team was requested'

Executando seu fluxo de trabalho com base no branch de cabeçalho ou de base de um pull request

É possível usar o filtro branches ou branches-ignore para configurar seu fluxo de trabalho para que sejam executados apenas em pull requests que aponte para branches específicos. Para obter mais informações, consulte "Sintaxe do fluxo de trabalho para o GitHub Actions".

Por exemplo, este fluxo de trabalho será executado quando alguém abrir um pull request que aponte para um branch cujo nome começa com releases/:

on:
  pull_request:
    types:
      - opened
    branches:    
      - 'releases/**'

Observação: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. Por exemplo, o fluxo de trabalho a seguir será executado somente quando um pull request que inclui uma mudança para um arquivo (.js) do JavaScript for aberto em um branch cujo nome começa com releases/:

on:
  pull_request:
    types:
      - opened
    branches:    
      - 'releases/**'
    paths:
      - '**.js'

Para executar um trabalho com base no nome do branch de cabeçalho do pull request (ao contrário do nome da branch de base do pull request), use o contexto github.head_ref em uma condicional. Por exemplo, este fluxo de trabalho será executado sempre que um pull request for aberto, mas o trabalho run_if só será executado se o cabeçalho do pull request for um branch cujo nome comece com releases/:

on:
  pull_request:
    types:
      - opened
jobs:
  run_if:
    if:  startsWith(github.head_ref, 'releases/')
    runs-on: ubuntu-latest
    steps:
      - run: echo "The head of this PR starts with 'releases/'"

Executando seu fluxo de trabalho com base em arquivos alterados em um pull request

Também é possível configurar o fluxo de trabalho para ser executado quando um pull request alterar arquivos específicos. Para obter mais informações, consulte "Sintaxe do fluxo de trabalho para o GitHub Actions".

Por exemplo, este fluxo de trabalho será executado quando um pull request incluir uma alteração para um arquivo (.js) do JavaScript:

on:
  pull_request:
    paths:
      - '**.js'

Observação: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. Por exemplo, o fluxo de trabalho a seguir será executado somente quando um pull request que inclui uma mudança para um arquivo (.js) do JavaScript for aberto em um branch cujo nome começa com releases/:

on:
  pull_request:
    types:
      - opened
    branches:    
      - 'releases/**'
    paths:
      - '**.js'

Workflows in forked repositories

Workflows don't run in forked repositories by default. Você deve habilitar o GitHub Actions na aba Actions (Ações) do repositório bifurcado.

Com exceção do GITHUB_TOKEN, os segredos não são disponibilizados para o executor quando um fluxo de trabalho é acionado a partir de um repositório bifurcado. The GITHUB_TOKEN has read-only permissions in forked repositories. Para obter mais informações, consulte "Autenticação com o GITHUB_TOKEN".

Eventos de pull request para repositórios bifurcados

For pull requests from a forked repository to the base repository, GitHub sends the pull_request, issue_comment, pull_request_review_comment, pull_request_review, and pull_request_target events to the base repository. No pull request events occur on the forked repository.

Quando um contribuidor envia um pull request para um repositório público pela primeira vez, é possível que um mantenedor com acesso de gravação tenha de aprovar fluxos de trabalho em execução no pull request. Para obter mais informações, consulte "Aprovar fluxos de trabalho executados a partir de bifurcações públicas".

Observação: fluxos de trabalho não são executados em repositórios privados quando você abre uma pull request de um repositório bifurcado.

Observação: Os fluxos de trabalho acionados por pull rquests de Dependabot são tratados como se fossem de um repositório bifurcado, e estão também sujeitos a essas restrições.

pull_request_comment (use issue_comment)

Para executar o fluxo de trabalho quando um comentário em um pull request (não no diff de um pull request) for criado, editado, ou excluído, use o evento issue_comment. Para a atividade relacionada a revisões de pull request ou comentários de revisão de pull request use os eventos pull_request_review ou pull_request_review_comment.

pull_request_review

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
pull_request_review- submitted
- edited
- dismissed
Último commit de merge no branch GITHUB_REFBranch de merge da PR refs/pull/:prNumber/merge

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Executa o fluxo de trabalho quando uma revisão de pull request é enviada, editada ou ignorada. Uma revisão de pull request é um grupo de comentários de revisão de pull request, além de um comentário e estado de texto. For activity related to pull request review comments or pull request comments, use the pull_request_review_comment or issue_comment events instead. For information about the pull request review APIs, see "PullRequestReview" in the GraphQL API documentation or "Pull request reviews" in the REST API documentation.

Por exemplo, você pode executar um fluxo de trabalho quando uma revisão de pull request tiver sido edited ou dismissed.

on:
  pull_request_review:
    types: [edited, dismissed]

Running a workflow when a pull request is approved

To run your workflow when a pull request has been approved, you can trigger your workflow with the submitted type of pull_request_review event, then check the review state with the github.event.review.state property. For example, this workflow will run whenever a pull request review is submitted, but the approved job will only run if the submitted review is an approving review:

on:
  pull_request_review:
    types: [submitted]

jobs:
  approved:
    if: github.event.review.state == 'approved'
    runs-on: ubuntu-latest
    steps:
      - run: echo "This PR was approved"

Workflows in forked repositories

Workflows don't run in forked repositories by default. Você deve habilitar o GitHub Actions na aba Actions (Ações) do repositório bifurcado.

Com exceção do GITHUB_TOKEN, os segredos não são disponibilizados para o executor quando um fluxo de trabalho é acionado a partir de um repositório bifurcado. The GITHUB_TOKEN has read-only permissions in forked repositories. Para obter mais informações, consulte "Autenticação com o GITHUB_TOKEN".

Eventos de pull request para repositórios bifurcados

For pull requests from a forked repository to the base repository, GitHub sends the pull_request, issue_comment, pull_request_review_comment, pull_request_review, and pull_request_target events to the base repository. No pull request events occur on the forked repository.

Quando um contribuidor envia um pull request para um repositório público pela primeira vez, é possível que um mantenedor com acesso de gravação tenha de aprovar fluxos de trabalho em execução no pull request. Para obter mais informações, consulte "Aprovar fluxos de trabalho executados a partir de bifurcações públicas".

Observação: fluxos de trabalho não são executados em repositórios privados quando você abre uma pull request de um repositório bifurcado.

Observação: Os fluxos de trabalho acionados por pull rquests de Dependabot são tratados como se fossem de um repositório bifurcado, e estão também sujeitos a essas restrições.

pull_request_review_comment

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
pull_request_review_comment- created
- edited
- deleted
Último commit de merge no branch GITHUB_REFBranch de merge da PR refs/pull/:prNumber/merge

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Executa o fluxo de trabalho quando um comentário de revisão de pull request é modificado. Um comentário de revisão de pull request é um comentário no diff de um pull request. Para a atividade relacionada aos revisores de pull request ou comentários de pull request use os eventos pull_request_review ou issue_comment. Para informações sobre as APIs de revisão de pull request, consulte "PullRequestReviewComment" na documentação da API do GraphQL ou "Comentários de revisão" na documentação da API REST.

Por exemplo, você pode executar um fluxo de trabalho quando um comentário de revisão de pull request tiver sido created ou deleted.

on:
  pull_request_review_comment:
    types: [created, deleted]

Workflows in forked repositories

Workflows don't run in forked repositories by default. Você deve habilitar o GitHub Actions na aba Actions (Ações) do repositório bifurcado.

Com exceção do GITHUB_TOKEN, os segredos não são disponibilizados para o executor quando um fluxo de trabalho é acionado a partir de um repositório bifurcado. The GITHUB_TOKEN has read-only permissions in forked repositories. Para obter mais informações, consulte "Autenticação com o GITHUB_TOKEN".

Eventos de pull request para repositórios bifurcados

For pull requests from a forked repository to the base repository, GitHub sends the pull_request, issue_comment, pull_request_review_comment, pull_request_review, and pull_request_target events to the base repository. No pull request events occur on the forked repository.

Quando um contribuidor envia um pull request para um repositório público pela primeira vez, é possível que um mantenedor com acesso de gravação tenha de aprovar fluxos de trabalho em execução no pull request. Para obter mais informações, consulte "Aprovar fluxos de trabalho executados a partir de bifurcações públicas".

Observação: fluxos de trabalho não são executados em repositórios privados quando você abre uma pull request de um repositório bifurcado.

Observação: Os fluxos de trabalho acionados por pull rquests de Dependabot são tratados como se fossem de um repositório bifurcado, e estão também sujeitos a essas restrições.

pull_request_target

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
pull_request- assigned
- unassigned
- labeled
- unlabeled
- opened
- edited
- closed
- reopened
- synchronize
- converted_to_draft
- ready_for_review
- locked
- unlocked
- review_requested
- review_request_removed
- auto_merge_enabled
- auto_merge_disabled
Último commit no branch de base do PRBranch-base do pull request

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Por padrão, um fluxo de trabalho só é executado quando o tipo de atividade de pull_request_targeté aberto,, sincronizado ou reaberto. Para acionar fluxos de trabalho para mais tipos de atividade, use a palavra-chave types. Você pode especificar diferentes tipos de atividade usando a palavra chave tipos. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Note: By default, only the opened, synchronize, and reopened activity types trigger workflows that run on the pull_request event. Para acionar fluxos de trabalho em diferentes tipos de atividade, use a palavra-chave tipos.

Executa o fluxo de trabalho quando ocorre uma atividade em no pull request no repositório do fluxo de trabalho. Por exemplo, se nenhum tipo de atividade for especificado, o fluxo de trabalho será executado quando um pull request é abertp ou reabertp ou quando o branch principal do pull request é atualizado.

Este evento é executado no contexto da base do pull request, em vez de no contexto do commit de merge, como faz o evento pull_request. Isso impede a execução de código inseguro do cabeçalho do pull request que poderia alterar seu repositório ou roubar quaisquer segredos que você usa no fluxo de trabalho. Este evento permite que seu fluxo de trabalho faça coisas como etiquetar ou comentar nos pull requests a partir das bifurcações. Evite usar este evento se você precisar criar ou executar o código a partir do pull request.

Warning: For workflows that are triggered by the pull_request_target event, the GITHUB_TOKEN is granted read/write repository permission unless the permissions key is specified and the workflow can access secrets, even when it is triggered from a fork. Embora o fluxo de trabalho seja executado no contexto da base do pull request, você deve certificar-se de que você não irá fazer checkout, construir ou executar o código não confiável do pull request com este evento. Additionally, any caches share the same scope as the base branch. To help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. Para obter mais informações, consulte "Proteger seus GitHub Actions e fluxos de trabalho: Evitar solicitações pwn" no site do GitHub Security Lab.

Por exemplo, você pode executar um fluxo de trabalho quando um pull request tiver sido atribuído, aberto, sincronizado ou reaberto.

on:
  pull_request_target:
    types: [assigned, opened, synchronize, reopened]

Executando seu fluxo de trabalho com base no branch de cabeçalho ou de base de um pull request

É possível usar o filtro branches ou branches-ignore para configurar seu fluxo de trabalho para que sejam executados apenas em pull requests que aponte para branches específicos. Para obter mais informações, consulte "Sintaxe do fluxo de trabalho para o GitHub Actions".

Por exemplo, este fluxo de trabalho será executado quando alguém abrir um pull request que aponte para um branch cujo nome começa com releases/:

on:
  pull_request_target:
    types:
      - opened
    branches:    
      - 'releases/**'

Observação: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. Por exemplo, o fluxo de trabalho a seguir será executado somente quando um pull request que inclui uma mudança para um arquivo (.js) do JavaScript for aberto em um branch cujo nome começa com releases/:

on:
  pull_request_target:
    types:
      - opened
    branches:    
      - 'releases/**'
    paths:
      - '**.js'

Para executar um trabalho com base no nome do branch de cabeçalho do pull request (ao contrário do nome da branch de base do pull request), use o contexto github.head_ref em uma condicional. Por exemplo, este fluxo de trabalho será executado sempre que um pull request for aberto, mas o trabalho run_if só será executado se o cabeçalho do pull request for um branch cujo nome comece com releases/:

on:
  pull_request:
    types:
      - opened
jobs:
  run_if:
    if:  startsWith(github.head_ref, 'releases/')
    runs-on: ubuntu-latest
    steps:
      - run: echo "The head of this PR starts with 'releases/'"

Executando seu fluxo de trabalho com base em arquivos alterados em um pull request

You can use the paths or paths-ignore filter to configure your workflow to run when a pull request changes specific files. Para obter mais informações, consulte "Sintaxe do fluxo de trabalho para o GitHub Actions".

Por exemplo, este fluxo de trabalho será executado quando um pull request incluir uma alteração para um arquivo (.js) do JavaScript:

on:
  pull_request_target:
    paths:
      - '**.js'

Observação: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. Por exemplo, o fluxo de trabalho a seguir será executado somente quando um pull request que inclui uma mudança para um arquivo (.js) do JavaScript for aberto em um branch cujo nome começa com releases/:

on:
  pull_request_target:
    types:
      - opened
    branches:    
      - 'releases/**'
    paths:
      - '**.js'

push

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
pushn/aCommit com push, exceto se excluindo um branch (quando é o branch padrão)ref atualizado

Observação: a carga de webhook disponível para o GitHub Actions não inclui os atributos added, removed e modified no objeto commit. Você pode recuperar o objeto de commit completo usando a API. For information, see "Commit" in the GraphQL API documentation or "Get a commit" in the REST API documentation.

Note: An event will not be created when you push more than three tags at once.

Runs your workflow when you push a commit or tag.

Por exemplo, você pode executar um fluxo de trabalho quando o evento push ocorrer.

on:
  push

Running your workflow only when a push to specific branches occurs

You can use the branches or branches-ignore filter to configure your workflow to only run when specific branches are pushed. Para obter mais informações, consulte "Sintaxe do fluxo de trabalho para o GitHub Actions".

For example, this workflow will run when someone pushes to main or to a branch that starts with releases/.

on:
  push:
    branches:    
      - 'main'
      - 'releases/**'

Observação: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. Por exemplo, o fluxo de trabalho a seguir será executado somente quando um push que inclui uma mudança para um arquivo (.js) do JavaScript é feito em um branch cujo nome começa com releases/:

on:
  push:
    types:
      - opened
    branches:    
      - 'releases/**'
    paths:
      - '**.js'

Executando o fluxo de trabalho somente quando ocorre um push de tags específicas

É possível usar o filtro tags ou tags-ignore para configurar o fluxo de trabalho para ser executado somente quando as tags específicas ou são enviadas por push. Para obter mais informações, consulte "Sintaxe do fluxo de trabalho para o GitHub Actions".

Por exemplo, este fluxo de trabalho será executado quando alguém fizer push de uma tag que começa com v1..

on:
  push:
    tags:        
      - v1.**

Executando seu fluxo de trabalho apenas quando um push afeta arquivos específicos

You can use the paths or paths-ignore filter to configure your workflow to run when a push to specific files occurs. Para obter mais informações, consulte "Sintaxe do fluxo de trabalho para o GitHub Actions".

Por exemplo, este fluxo de trabalho será executado quando alguém fizer uma alteração em um arquivo (.js) do JavaScript:

on:
  push:
    paths:
      - '**.js'

Observação: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. Por exemplo, o fluxo de trabalho a seguir será executado somente quando um push que inclui uma mudança para um arquivo (.js) do JavaScript é feito em um branch cujo nome começa com releases/:

on:
  push:
    types:
      - opened
    branches:    
      - 'releases/**'
    paths:
      - '**.js'

registry_package

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
registry_package- publicado
- atualizado
Commit do pacote publicadoBranch ou tag do pacote publicado

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Executa o fluxo de trabalho quando uma atividade relacionada ao GitHub Package Registry ocorre no seu repositório. Para obter mais informações, consulte "Documentação do GitHub Package Registry".

Por exemplo, você pode executar um fluxo de trabalho quando um pacote tiver sido publicado.

em:
  registry_package:
    tipos: [published]

versão

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
versão- published
- unpublished
- created
- edited
- deleted
- prereleased
- released
Último commit na versão com tagTag da versão

Observação: Mais de um tipo de atividade aciona este evento. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Os fluxos de trabalho não estão acionados para os tipos de atividades criados, editados ou excluídos para rascunhos de versões. Ao criar a sua versão por meio da interface de usuário do navegador de GitHub, a sua versão poderá ser automaticamente salva como rascunho.

Observação: O tipoprereleasednão será acionado para pré-versões publicadas a partir de versões de rascunho, mas o tipo <code>published será acionado. Se você quiser que um fluxo de trabalho seja executado quando e forem publicadas pré-versões, assine published em vez de released e prereleased.

Executa o fluxo de trabalho quando a atividade de da versão no repositório ocorre. For information about the release APIs, see "Release" in the GraphQL API documentation or "Releases" in the REST API documentation.

Por exemplo, você pode executar um fluxo de trabalho quando uma versão tiver sido published.

on:
  release:
    types: [published]

repository_dispatch

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
repository_dispatchPersonalizadoÚltimo commit no branch padrãoBranch padrão

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Você pode usar a API do GitHub para acionar um evento do webhook denominado repository_dispatch quando quiser acionar um fluxo de trabalho para uma atividade que ocorre fora do GitHub. Para obter mais informações, consulte "Criar um evento de envio do repositório".

When you make a request to create a repository_dispatch event, you must specify an event_type to describe the activity type. By default, all repository_dispatch activity types trigger a workflow to run. You can use the types keyword to limit your workflow to run when a specific event_type value is sent in the repository_dispatch webhook payload.

on:
  repository_dispatch:
    types: [on-demand-test]

Any data that you send through the client_payload parameter will be available in the github.event context in your workflow. Por exemplo, se você enviar esse texto de solicitação quando criar um evento de despacho de repositório:

{
  "event_type": "test_result",
  "client_payload": {
    "passed": false,
    "message": "Error: timeout"
  }
}

então você poderá acessar a carga em um fluxo de trabalho assim:

on:
  repository_dispatch:
    types: [test_result]

jobs:
  run_if_failure:
    if: ${{ !github.event.client_payload.passed }}
    runs-on: ubuntu-latest
    steps:
      - env:
          MESSAGE: ${{ github.event.client_payload.message }}
        run: echo $MESSAGE

schedule

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
n/an/aÚltimo commit no branch padrãoBranch padrão

Observação: O evento agendamento pode ser adiado durante períodos de cargas altas de execuções do fluxo de trabalho de GitHub Actions. Os tempos de carregamento altos incluem o início de cada hora. Para diminuir a probabilidade de atraso, agende o fluxo de trabalho para ser executado em uma parte diferente da hora.

O evento agenda permite que você acione um fluxo de trabalho em um horário agendado.

É possível programar um fluxo de trabalho para ser executado em horários de UTC específicos usando a sintaxe de cron POSIX. Fluxos de trabalho agendados executados no último commit no branch padrão ou branch de base. O intervalo mais curto que você pode executar fluxos de trabalho agendados é a cada 15 minutos.

Este exemplo aciona o fluxo de trabalho todos os dias às 17:30 e 17:30 UTC:

on:
  schedule:
    # * is a special character in YAML so you have to quote this string
    - cron:  '30 5,17 * * *'

A single workflow can be triggered by multiple schedule events. You can access the schedule event that triggered the workflow through the github.event.schedule context. This example triggers the workflow to run at 5:30 UTC every Monday-Thursday, but skips the Not on Monday or Wednesday step on Monday and Wednesday.

on:
  schedule:
    - cron: '30 5 * * 1,3'
    - cron: '30 5 * * 2,4'

jobs:
  test_schedule:
    runs-on: ubuntu-latest
    steps:
      - name: Not on Monday or Wednesday
        if: github.event.schedule != '30 5 * * 1,3'
        run: echo "This step will be skipped on Monday and Wednesday"
      - name: Every time
        run: echo "This step will always run"

A sintaxe cron tem cinco campos separados por um espaço, e cada campo representa uma unidade de tempo.

┌───────────── minuto (0 a 59)
│ ┌───────────── hora (0 a 23)
│ │ ┌───────────── dia do mês (1 a 31)
│ │ │ ┌───────────── mês (1 - 12 ou dezembro a janeiro)
│ │ │ │ ┌───────────── dia da semana (0 a 6 ou domingo a sábado)
│ │ │ │ │
│ │ │ │ │
│ │ │ │ │
* * * * *

Você pode usar estes operadores em qualquer um dos cinco campos:

OperadorDescriçãoExemplo
*Qualquer valor15 * * * * runs at every minute 15 of every hour of every day.
,Separador de lista de valor2,10 4,5 * * * executa no minuto 2 e 10 da quarta e quinta hora de todos os dias.
-Intervalo de valores30 4-6 * * * runs at minute 30 of the 4th, 5th, and 6th hour.
/Valores de etapa20/15 * * * * executa a cada 15 minutos começando do miuto 20 até o 59 (minutos 20, 35 e 50).

Observação: o GitHub Actions não é compatível com a sintaxe não padrão @yearly, @monthly, @weekly, @daily, @hourly e @reboot.

Você pode usar crontab guru para ajudar a gerar a sintaxe cron e confirmar a hora em que ela será executada. Para ajudar você a começar, há também uma lista de exemplos de crontab guru.

As notificações de fluxos de trabalho agendados são enviadas ao usuário que modificou a sintaxe cron no arquivo do fluxo de trabalho. For more information, see "Notifications for workflow runs."

status

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
statusn/aÚltimo commit no branch padrãon/a

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Executa o fluxo de trabalho quando o status do commit de Git é alterado. For example, commits can be marked as error, failure, pending, or success. If you want to provide more details about the status change, you may want to use the check_run event. For information about the commit status APIs, see "Status" in the GraphQL API documentation or "Statuses" in the REST API documentation.

Por exemplo, você pode executar um fluxo de trabalho quando o evento status ocorrer.

on:
  status

If you want to run a job in your workflow based on the new commit state, you can use the github.event.state context. For example, the following workflow triggers when a commit status changes, but the if_error_or_failure job only runs if the new commit state is error or failure.

on:
  status
jobs:
  if_error_or_failure:
    runs-on: ubuntu-latest
    if: >-
      github.event.state == 'error' ||
      github.event.state == 'failure'
    steps:
      - env:
          DESCRIPTION: ${{ github.event.description }}
        run: |
          echo The status is error or failed: $DESCRIPTION

inspecionar

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
inspecionar- startedÚltimo commit no branch padrãoBranch padrão

Note: Mais de um tipo de atividade aciona este evento. Although only the started activity type is supported, specifying the activity type will keep your workflow specific if more activity types are added in the future. For information about each activity type, see "Webhook events and payloads." Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Runs your workflow when the workflow's repository is starred. For information about the pull request APIs, see "addStar" in the GraphQL API documentation or "Starring" in the REST API documentation.

For example, you can run a workflow when someone stars a repository, which is the started activity type for a watch event.

on:
  watch:
    types: [started]

workflow_call

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
Igual ao fluxo de trabalho de chamadasn/aIgual ao fluxo de trabalho de chamadasIgual ao fluxo de trabalho de chamadas

workflow_call is used to indicate that a workflow can be called by another workflow. When a workflow is triggered with the workflow_call event, the event playload in the called workflow is the same event payload from the calling workflow. Para obter mais informações, consulte "Reutilizando fluxos de trabalho".

O exemplo abaixo só executa o fluxo de trabalho quando é chamado a partir de outro fluxo de trabalho:

on: workflow_call

workflow_dispatch

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
workflow_dispatchn/aÚltimo commit de merge no branch GITHUB_REFBranch que recebeu envio

To manually trigger a workflow, use the workflow_dispatch event. You can manually trigger a workflow run using the GitHub API, GitHub CLI, or GitHub browser interface. Para obter mais informações, consulte "Executando um fluxo de trabalho manualmente."

on: workflow_dispatch

Providing inputs

É possível configurar as propriedades de entrada definidas por personalização, os valores-padrão de entrada e as entradas obrigatórias para o evento diretamente no seu fluxo de trabalho. When you trigger the event, you can provide the ref and any inputs. Quando o fluxo de trabalho é executado, você pode acessar os valores de entrada no contexto github.event.inputs. Para obter mais informações, consulte "Contextos".

This example defines inputs called logLevel, tags, and environment. You pass values for these inputs to the workflow when you run it. This workflow then prints the values to the log, using the github.event.inputs.logLevel, github.event.inputs.tags, and github.event.inputs.environment context properties.

on: 
  workflow_dispatch:
    inputs:
      logLevel:
        description: 'Log level'     
        required: true
        default: 'warning' 
        type: choice
        options:
        - info
        - warning
        - debug 
      tags:
        description: 'Test scenario tags'
        required: false 
        type: boolean
      environment:
        description: 'Environment to run tests against'
        type: environment
        required: true 

jobs:
  log-the-inputs:
    runs-on: ubuntu-latest
    steps:
      - run: |
          echo "Log level: $LEVEL"
          echo "Tags: $TAGS"
          echo "Environment: $ENVIRONMENT"
        env:
          LEVEL: ${{ github.event.inputs.logLevel }}
          TAGS: ${{ github.event.inputs.tags }}
          ENVIRONMENT: ${{ github.event.inputs.environment }}

Se você executar este fluxo de trabalho em um navegador, você deverá inserir valores para as entradas necessárias manualmente antes de o fluxo de trabalho ser executado.

Inserindo entradas para um fluxo de trabalho

Você também pode passar entradas quando executar um fluxo de trabalho a partir de um script ou usando GitHub CLI. Por exemplo:

gh workflow run run-tests.yml -f logLevel=warning -f tags=false -f environment=staging

Para obter mais informações, consulte as informações do GitHub CLI em "Executando um fluxo de trabalho manualmente".

workflow_run

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
workflow_run- completed
- requested
Último commit no branch padrãoBranch padrão

Note: Mais de um tipo de atividade aciona este evento. The requested activity type does no occur when a workflow is re-run. For information about each activity type, see "Webhook events and payloads." Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Observação: Este evento acionará apenas um fluxo de trabalho executado se o arquivo do fluxo de trabalho estiver no branch-padrão.

Note: You can't use workflow_run to chain together more than three levels of workflows. Por exemplo, se você tentar acionar cinco fluxos de trabalho (denominado B a F) para serem executados sequencialmente após a execução de um fluxo de trabalho inicial A (isto é: ABCDEF), os fluxos de trabalho E e F não serão executados.

This event occurs when a workflow run is requested or completed. It allows you to execute a workflow based on execution or completion of another workflow. The workflow started by the workflow_run event is able to access secrets and write tokens, even if the previous workflow was not. This is useful in cases where the previous workflow is intentionally not privileged, but you need to take a privileged action in a later workflow.

Neste exemplo, um fluxo de trabalho está configurado para ser executado após o fluxo de trabalho "Executar Testes" separado ser concluído.

on:
  workflow_run:
    workflows: [Run Tests]
    types:
      - completed

If you specify multiple workflows for the workflow_run event, only one of the workflows needs to run. For example, a workflow with the following trigger will run whenever the "Staging" workflow or the "Lab" workflow completes.

on:
  workflow_run:
    workflows: [Staging, Lab]
    types:
      - completed

Executando um fluxo de trabalho com base na conclusão de outro fluxo de trabalho

A execução de um fluxo de trabalho é acionada independentemente da conclusão do fluxo de trabalho anterior. If you want to run a job or step based on the result of the triggering workflow, you can use a conditional with the github.event.workflow_run.conclusion property. For example, this workflow will run whenever a workflow named "Build" completes, but the on-success job will only run if the "Build" workflow succeeded, and the on-failure job will only run if the "Build" workflow failed:

on:
  workflow_run:
    workflows: [Build]
    types: [completed]

jobs:
  on-success:
    runs-on: ubuntu-latest
    if: ${{ github.event.workflow_run.conclusion == 'success' }}
    steps:
      - run: echo 'The triggering workflow passed'
  on-failure:
    runs-on: ubuntu-latest
    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
    steps:
      - run: echo 'The triggering workflow failed'

Limiting your workflow to run based on branches

You can use the branches or branches-ignore filter to specify what branches the triggering workflow must run on in order to trigger your workflow. Para obter mais informações, consulte " Sintaxe de fluxo de trabalhopara o GitHub Actions". For example, a workflow with the following trigger will only run when the workflow named Build runs on a branch named canary.

on:
  workflow_run:
    workflows: [Build]
    types: [requested]
    branches: [canary]

Usando dados do fluxo de trabalho acionador

You can access the workflow_run event payload that corresponds to the workflow that triggered your workflow. For example, if your triggering workflow generates artifacts, a workflow triggered with the workflow_run event can access these artifacts.

The following workflow uploads data as an artifact. (In this simplified example, the data is the pull request number.)

name: Upload data

on:
  pull_request:

jobs:
  upload:
    runs-on: ubuntu-latest

    steps:        
      - name: Save PR number
        env:
          PR_NUMBER: ${{ github.event.number }}
        run: |
          mkdir -p ./pr
          echo $PR_NUMBER > ./pr/pr_number
      - uses: actions/upload-artifact@v2
        with:
          name: pr_number
          path: pr/

Quando uma execução do fluxo de trabalho acima é concluída, ela aciona a execução de um fluxo de trabalho seguinte. The following workflow uses the github.event.workflow_run context and the GitHub REST API to download the artifact that was uploaded by the above workflow, unzips the downloaded artifact, and comments on the pull request whose number was uploaded as an artifact.

name: Use the data

on:
  workflow_run:
    workflows: [Upload data]
    types:
      - completed

jobs:
  download:
    runs-on: ubuntu-latest
    steps:
      - name: 'Download artifact'
        uses: actions/github-script@v5
        with:
          script: |
            let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
               owner: context.repo.owner,
               repo: context.repo.repo,
               run_id: context.payload.workflow_run.id,
            });
            let matchArtifact = allArtifacts.data.artifacts.filter((artifact) => {
              return artifact.name == "pr_number"
            })[0];
            let download = await github.rest.actions.downloadArtifact({
               owner: context.repo.owner,
               repo: context.repo.repo,
               artifact_id: matchArtifact.id,
               archive_format: 'zip',
            });
            let fs = require('fs');
            fs.writeFileSync(`${process.env.GITHUB_WORKSPACE}/pr_number.zip`, Buffer.from(download.data));

      - name: 'Unzip artifact'
        run: unzip pr_number.zip

      - name: 'Comment on PR'
        uses: actions/github-script@v5
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          script: |
            let fs = require('fs');
            let issue_number = Number(fs.readFileSync('./pr_number'));
            await github.rest.issues.createComment({
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: issue_number,
              body: 'Thank you for the PR!'
            });