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 Enterprise Server em um período agendado ou quando ocorre um evento externo do GitHub Enterprise Server.

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." By default, all activity types trigger workflows that run on this event. 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". By default, all activity types trigger workflows that run on this event. 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. By default, all activity types trigger workflows that run on this event. 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

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". By default, all activity types trigger workflows that run on this event. 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." By default, all activity types trigger workflows that run on this event. 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". By default, all activity types trigger workflows that run on this event. 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.

Se você deseja executar seu fluxo de trabalho quando uma etiqueta for adicionada ou removida de um problema, pull request ou discussão, use os tipos de atividade o labeled ou unlabeled para os eventos issues, pull_request, pull_request_target ou discussion.

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." By default, all activity types trigger workflows that run on this event. 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.

Se quiser executar o seu fluxo de trabalho quando um problema for adicionado ou removido de um marco, use os tipos de atividade os milestoned ou demilestoned para os eventos issues.

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". By default, all activity types trigger workflows that run on this event. 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.

Executa o fluxo de trabalho quando um quadro de projeto é criado ou modificado. Para atividades relacionadas a cartões ou colunas em um quadro de projeto, use os eventos project_card ou project_column. 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." By default, all activity types trigger workflows that run on this event. 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.

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". By default, all activity types trigger workflows that run on this event. 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.

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. Para acionar fluxos de trabalho em diferentes tipos de atividade, use a palavra-chave tipos. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

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 executados 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 reaberto ou quando o branch principal do pull request é atualizado. Para atividade relacionada a revisões de pull request, comentários de revisão de pull request ou comentários de pull request, use os eventos o pull_request_review, pull_request_review_comment ou issue_comment. Para informações sobre as APIs do pull request, consulte "PullRequest" na documentação da API do GraphQL ou "Pull requests" na documentação da API REST.

Observe que GITHUB_SHA para este evento é o último commit de merge de merge do branch de merge do pull request. Se você deseja obter o ID do commit para o último commit na branch principal do pull request, use github.event.pull_request.head.sha.

Por exemplo, você pode executar um fluxo de trabalho quando um pull request for aberto ou reaberto.

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. Por exemplo, este fluxo de trabalho será executado quando uma revisão for solicitada em um pull request, mas o trabalho de specific_review_requested só será executado quando uma análise de octo-team for solicitada.

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 de fluxo de trabalhopara 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: Se você usar o filtro branches e o filtro caminhos, o fluxo de trabalho só será executado quando ambos os filtros estiverem satisfeitos. 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 de fluxo de trabalhopara 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: Se você usar o filtro branches e o filtro caminhos, o fluxo de trabalho só será executado quando ambos os filtros estiverem satisfeitos. 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'

Executando o fluxo de trabalho quando um executado um merge de pull request

Quando um pull request faz merge, o pull request é automaticamente fechado. Para executar um fluxo de trabalho quando um pull request é mesclado, use o tipo de evento pull_request fechado junto com uma condição que verifica o valor de merged do evento. Por exemplo, o fluxo de trabalho a seguir será executado sempre que um pull request for fechado. O trabalho if_merged só será executado se o pull request também tiver sido mesclado.

on:
  pull_request:
    types:
      - closed

jobs:
  if_merged:
    if: github.event.pull_request.merged == true
    runs-on: ubuntu-latest
    steps:
    - run: |
        echo The PR was merged

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 Enterprise Server 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.

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." By default, all activity types trigger workflows that run on this event. 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. Para atividade relacionada a comentários de revisão de pull request ou comentários de pull request, use os eventos pull_request_review_comment ou issue_comment. Para obter informações sobre as APIs de revisão de pull request, consulte "PullRequestReview" na documentação da API do GraphQL ou "Revisões de pull request" na documentação da API REST.

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]

Executando um fluxo de trabalho quando um pull request é aprovado

Para executar o fluxo de trabalho quando um pull request for aprovado, você poderá acionar o seu fluxo de trabalho com o tipo submitted do evento pull_request_review e, em seguida, verificar o estado da revisão com a propriedade github.event.review.state. Por exemplo, este fluxo de trabalho será executado sempre que uma revisão de pull request for enviada, mas o trabalho aprovado só será executado se a revisão enviada for uma revisão de aprovação:

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 Enterprise Server 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.

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". By default, all activity types trigger workflows that run on this event. 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 Enterprise Server 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.

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 em diferentes tipos de atividade, use a palavra-chave tipos. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

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 reaberto 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.

Aviso: Para fluxos de trabalho acionados pelo evento pull_request_target, o GITHUB_TOKEN recebe permissão de leitura/gravação para o repositório, a menos que a chave permissões seja especificada e o fluxo de trabalho possa acessar segredos, mesmo quando é acionado por uma bifurcação. 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. Além disso, qualquer cache compartilha o mesmo escopo do ramo de base. Para evitar envenenamento do cache, você não deve salvar o cache se houver a possibilidade de que o conteúdo do cache tenha sido alterado. 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 de fluxo de trabalhopara 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: Se você usar o filtro branches e o filtro caminhos, o fluxo de trabalho só será executado quando ambos os filtros estiverem satisfeitos. 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

Você pode usar o filtro paths ou paths-ignore para configurar seu fluxo de trabalho para ser executado quando um pull request altera arquivos específicos. Para obter mais informações, consulte " Sintaxe de fluxo de trabalhopara 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: Se você usar o filtro branches e o filtro caminhos, o fluxo de trabalho só será executado quando ambos os filtros estiverem satisfeitos. 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'

Executando o fluxo de trabalho quando um executado um merge de pull request

Quando um pull request faz merge, o pull request é automaticamente fechado. Para executar um fluxo de trabalho quando um pull request é mesclado, use o tipo de evento pull_request_target fechado junto com uma condição que verifica o valor de merged do evento. Por exemplo, o fluxo de trabalho a seguir será executado sempre que um pull request for fechado. O trabalho if_merged só será executado se o pull request também tiver sido mesclado.

on:
  pull_request_target:
    types:
      - closed

jobs:
  if_merged:
    if: github.event.pull_request.merged == true
    runs-on: ubuntu-latest
    steps:
    - run: |
        echo The PR was merged

push

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
pushn/aAo excluir um branch, o SHA no fluxo de trabalho executado (e seus refs associados) reverte para o branch padrão do repositório.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. Para obter mais informações, consulte "Commit" na documentação da API do GraphQL ou Obter um commit" na documentação da API REST.

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

Executa o fluxo de trabalho quando você faz push de um commit ou tag.

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

on:
  push

Observação: Quando um evento de webhook push aciona a execução de um fluxo de trabalho, o campo "enviado por" da Interface do Actions mostra a conta do pusher e não o autor ou autor oiu committer. No entanto, se as alterações forem enviadas para um repositório que usa a autenticação SSH com uma chave de implantação, o campo "enviado por" será o administrador do repositório que verificou a chave de implantação quando foi adicionado a um repositório.

Executando o fluxo de trabalho apenas quando um push para branches específicos ocorre

É possível usar o filtro branches ou branches-ignore para configurar seu fluxo de trabalho para ser executado somente quando branches específicos são enviados por push. Para obter mais informações, consulte " Sintaxe de fluxo de trabalhopara o GitHub Actions".

Por exemplo, este fluxo de trabalho será executado quando alguém fizer push para o principal ou para um branch que começa com releases/.

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

Observação: Se você usar o filtro branches e o filtro caminhos, o fluxo de trabalho só será executado quando ambos os filtros estiverem satisfeitos. 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:
    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 de fluxo de trabalhopara 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

Você pode usar o filtro paths ou paths-ignore para configurar o fluxo de trabalho para que seja executado quando ocorrer um push para arquivos específicos. Para obter mais informações, consulte " Sintaxe de fluxo de trabalhopara 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: Se você usar o filtro branches e o filtro caminhos, o fluxo de trabalho só será executado quando ambos os filtros estiverem satisfeitos. 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:
    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." By default, all activity types trigger workflows that run on this event. 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 a nova versão de um pacote tiver sido publicada.

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 tagRef da tag da versão refs/tags/<tag_name>

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." By default, all activity types trigger workflows that run on this event. 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 Enterprise Server, 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. Para obter informações sobre as APIs de versões, consulte "Release" na documentação da API do GraphQL ou "Versões" na documentação da API REST.

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 Enterprise Server para acionar um evento do webhook denominado repository_dispatch quando quiser acionar um fluxo de trabalho para uma atividade que ocorre fora do GitHub Enterprise Server. Para obter mais informações, consulte "Criar um evento de envio do repositório".

Ao fazer uma solicitação para criar um evento repository_dispatch, você deve especificar um event_type para descrever o tipo de atividade. Por padrão, todos os tipos de atividade de repository_dispatch acionam a execução de um fluxo de trabalho. Você pode usar a palavra-chave tipos para limitar a execução do fluxo de trabalho quando um valor específico de event_type for enviado para a carga do webhook de repository_dispatch.

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

Observação: O valor do event_type é limitado a 100 caracteres.

Todos os dados que você enviar através do parâmetro client_payload estarão disponíveis no contexto github.event no seu fluxo de trabalho. 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 5 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 * * * é executado a cada quarto de hora todos os dias.
,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 * * é executado a cada meia hora da quarta, quinta e sexta hora.
/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. Para obter mais informações, consulte "Notificações para execuções de fluxo de trabalho".

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. Por exemplo, os commits podem ser marcados como erro, falha, pendente ou sucesso. Se você quiser fornecer mais informações sobre a mudança de status, você deverá usar o evento check_run. Para obter informações sobre as APIs de status do commit, consulte "Status" na documentação da API do GraphQL ou "Status" na documentação da API REST.

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

on:
  status

Se você quiser executar um trabalho no seu fluxo de trabalho com base no novo estado do commit, você poderá usar o contexto github.event.state. Por exemplo, os seguintes acionadores de fluxo de trabalho quando um commit muda de status mas o trabalho if_error_or_failed só é executado se o novo estado de commit for erro ou falha.

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

Observação: Mais de um tipo de atividade aciona este evento. Embora apenas o tipo de atividade iniciado seja compatível, especificar que o tipo de atividade manterá seu fluxo de trabalho específico se mais tipos de atividade forem adicionados posteriormente. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". By default, all activity types trigger workflows that run on this event. 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 o repositório do fluxo de trabalho é favoritado. Para obter informações sobre as APIs do pull request, consulte "addStar" na documentação da API do GraphQL ou "Marcando como favorito" na documentação da API REST.

Por exemplo, você pode executar um fluxo de trabalho quando alguém favorita um repositório, que é o tipo de atividade favoritada para um evento de inspeção.

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 é usado para indicar que um fluxo de trabalho pode ser chamado por outro fluxo de trabalho. Quando um fluxo de trabalho é acionado com o evento workflow_call a carga de eventos no fluxo de trabalho chamado é a mesma carga de eventos do fluxo de trabalho de chamada. 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

Para acionar manualmente um fluxo de trabalho, use o evento workflow_dispatch. Você pode acionar manualmente uma execução de fluxo de trabalho usando a API do GitHub Enterprise Server, GitHub CLI ou a interface do nevegador de GitHub Enterprise Server. Para obter mais informações, consulte "Executando um fluxo de trabalho manualmente."

on: workflow_dispatch

Fornecendo entradas

É 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. Ao iniciar o evento, você pode fornecer ref e qualquer entrada. Quando o fluxo de trabalho é executado, você pode acessar os valores de entrada no contexto de github.event.inputs. Para obter mais informações, consulte "Contextos".

Este exemplo define as entradas chamadas logLevel, tags e ambiente. Você passa os valores destas entradas para o fluxo de trabalho quando o executa. Em seguida, esse fluxo de trabalho imprime os valores no log, usando as propriedades de contexto de github.event.inputs.logLevel, github.event.inputs.tags e github.event.inputs.environment.

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

Observação: Mais de um tipo de atividade aciona este evento. O tipo de atividade solicitado não ocorre quando um fluxo de trabalho é executado novamente. Para obter informações sobre cada tipo de atividade, consulte "Eventos de webhook e cargas". By default, all activity types trigger workflows that run on this event. 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: Você não pode usar workflow_run para encadear mais de três níveis de fluxos de trabalho. 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.

Este evento ocorre quando uma execução do fluxo de trabalho é solicitada ou concluída. Ele permite que você execute um fluxo de trabalho baseado na execução ou conclusão de outro fluxo de trabalho. O fluxo de trabalho iniciado pelo evento workflow_run pode acessar segredos e escrever tokens, mesmo que o fluxo de trabalho anterior não possa. Isso é útil em casos em que o fluxo de trabalho anterior não é intencionalmente privilegiado, mas você precisa tomar uma ação privilegiada em um fluxo de trabalho posterior.

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

Se você especificar vários fluxos de trabalho para o evento workflow_run, apenas um dos fluxos de trabalho deverá ser executado. Por exemplo, um fluxo de trabalho com o seguinte gatilho será executado sempre que o fluxo de trabalho "Staging" ou "Lab" forem concluídos.

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. Se você deseja executar um trabalho ou etapa com base no resultado do fluxo de trabalho acionado, você poderá usar uma condição com a propriedade github.event.workflow_run.conclusion. Por exemplo, este fluxo de trabalho será executado sempre que um fluxo de trabalho chamado "Criação" for concluído, mas o trabalho on-sucess só será executado se a "Criação" for bem-sucedida e o trabalho on-failed só será executado se o fluxo de trabalho "Criação" falhar:

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'

Limitando seu fluxo de trabalho para ser executado com base em branches

Você pode usar o filtro dos branches ou branches-ignore para especificar em quais branches o fluxo de trabalho de acionamento deve ser executado para acionar seu fluxo de trabalho. Para obter mais informações, consulte " Sintaxe de fluxo de trabalhopara o GitHub Actions". Por exemplo, um fluxo de trabalho com o seguinte gatilho só será executado quando o fluxo de trabalho chamado Build for executado em um branch denominado canary.

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

Usando dados do fluxo de trabalho acionador

Você pode acessar a carga do evento workflow_run que corresponde ao fluxo de trabalho que acionou seu fluxo de trabalho. Por exemplo, se o fluxo de trabalho de acionamento gerar artefatos, um fluxo de trabalho acionado com o evento workflow_run poderá acessar esses artefatos.

O seguinte fluxo de trabalho faz o upload de dados como um artefato. (Neste exemplo simplificado, os dados são o número do pull request.)

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@v3
        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. O fluxo de trabalho a seguir usa o contexto github.event.workflow_run e a API REST de GitHub Enterprise Server para fazer o download do artefato que foi carregado pelo fluxo de trabalho acima, abre o zip do artefato baixado e faz comentários no pull request cujo número foi carregado como um artefato.

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@v6
        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@v6
        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!'
            });