Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

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.

GitHub Actions está disponível com GitHub Free, GitHub Pro, GitHub Free para organizações, GitHub Team, GitHub Enterprise Cloud e GitHub One. GitHub Actions is not available for private repositories owned by accounts using legacy per-repository plans. Para obter mais informações, consulte os "produtos do GitHub".

Neste artigo

Did this doc help you?

Sobre eventos de fluxo de trabalho

Você pode configurar a execução de seu fluxo de trabalho quando eventos webhook são criados a partir da atividade no GitHub. Os fluxos de trabalho podem usar mais de um evento webhook para acionar a execução de um fluxo de trabalho. Para obter mais informações, consulte "Webhooks. Para obter mais informações sobre a sintaxe on, consulte "Sintaxe de fluxo de trabalho do GitHub Actions".

As etapas a seguir ocorrem para acionar a execução de um fluxo de trabalho:

  1. Um evento ocorre no seu repositório e o webhook do evento resultante tem um commit SHA e um Git ref associado.

  2. É feita uma pesquisa no diretório .github/workflows com relação aos arquivos do fluxo de trabalho no SHA ou Git ref associado. Os arquivos do fluxo de trabalho devem estar presentes nesse commit SHA ou no Git ref para serem considerados.

    Por exemplo, se o evento ocorreu em um determinado branch do repositório, os arquivos do fluxo de trabalho devem estar presentes no repositório desse branch.

  3. Os arquivos do fluxo de trabalho para o commit SHA e Git ref são inspecionados, e aciona-se uma nova execução de fluxo de trabalho para quaisquer fluxos de trabalho com valores on: que correspondem ao evento de acionado.

    O fluxo de trabalho é executado no código do seu repositório no mesmo commit SHA e Git ref que acionou o evento. Quando um fluxo de trabalho é executado, o GitHub configura as variáveis de ambiente GITHUB_SHA (commit SHA) e GITHUB_REF (Git ref) no ambiente do executor. Para obter mais informações, consulte "Usando variáveis de ambiente".

Observação: Você não pode acionar novas execuções do fluxo de trabalho usando o GITHUB_TOKEN. Para obter mais informações, consulte "Acionando novos fluxos de trabalho usando um token de acesso pessoal".

Exemplo com um único evento
# Trigger on push
on: push
Exemplo com uma lista de eventos
# Trigger the workflow on push or pull request
on: [push, pull_request]
Exemplo usando vários eventos com tipos de atividade ou configuração

Se você precisar especificar tipos de atividade ou configuração para um evento, você deve configurar cada evento separadamente. Você deve anexar dois pontos (:) a todos os eventos, incluindo eventos sem configuração.

on:
  # Trigger the workflow on push or pull request,
  # but only for the master branch
  push:
    branches:
      - master
  pull_request:
    branches:
      - master
  # Also trigger on page_build, as well as release created events
  page_build:
  release:
    types: # This configuration does not affect the page_build event above
      - created

Eventos webhook

É possível configurar o fluxo de trabalho para ser executado quando eventos webhook forem criados no GitHub. Alguns eventos são acionados por mais de um tipo de atividade. Se mais de um tipo de atividade acionar o evento, especifique quais tipos de atividade ativarão a execução do fluxo de trabalho.

check_run

Executa o fluxo de trabalho sempre que o evento check_run ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Execuções de verificação".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

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

on:
  check_run:
    types: [rerequested, requested_action]

check_suite

Executa o fluxo de trabalho sempre que o evento check_suite ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Conjuntos de verificações".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou 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.

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

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

Por exemplo, você pode executar um fluxo de trabalho quando um conjunto de verificações tiver sido rerequested ou completed.

on:
  check_suite:
    types: [rerequested, completed]

create

Executa o fluxo de trabalho sempre que alguém cria um branch ou tag, o que aciona o evento create. Para obter informações sobre a API REST, consulte "Criar uma referência".

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

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

on:
  create

delete

Executa o fluxo de trabalho sempre que alguém exclui um branch ou tag, o que aciona o evento delete. Para obter informações sobre a API REST, consulte "Excluir uma referência".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

on:
  delete

implantação

Executa o fluxo de trabalho sempre que alguém cria uma implantação, o que aciona o evento deployment. Implantações criadas com um commit SHA podem não ter um Git ref. Para obter informações sobre a API REST, consulte "Implantações".

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

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

on:
  deployment

implantação_status

Executa o fluxo de trabalho sempre que um terceiro fornece um status de implantação, o que aciona o evento deployment_status. Implantações criadas com um commit SHA podem não ter um Git ref. Para obter informações sobre a API REST, consulte "Criar um status de implantação".

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

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

on:
  deployment_status

bifurcação

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

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

on:
  fork

gollum

Executa o fluxo de trabalho quando alguém cria ou atualiza uma página wiki, o que aciona o evento gollum.

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

on:
  gollum

issue_comment

Executa o fluxo de trabalho sempre que o evento issue_comment ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Comentários do problema".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

Por exemplo, você pode executar um fluxo de trabalho quando um comentário de problema tiver sido created ou deleted.

on:
  issue_comment:
    types: [created, deleted]

Problemas

Executa o fluxo de trabalho sempre que o evento issues ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "problemas".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

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

Executa o fluxo de trabalho sempre que o evento label ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Etiquetas".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

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

on:
  label:
    types: [created, deleted]

marco

Executa o fluxo de trabalho sempre que o evento milestone ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Marcos".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

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

on:
  milestone:
    types: [opened, deleted]

page_build

Executa o fluxo de trabalho sempre que alguém faz push em um branch habilitado para o GitHub Pages, o que aciona o evento page_build. Para obter informações sobre a API REST, consulte "Páginas".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

on:
  page_build

project

Executa o fluxo de trabalho sempre que o evento project ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Projetos".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

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

on:
  project:
    types: [created, deleted]

project_card

Executa o fluxo de trabalho sempre que o evento project_card ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Cartões de projeto".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

Por exemplo, você pode executar um fluxo de trabalho quando um cartão de projeto tiver sido opened ou deleted.

on:
  project_card:
    types: [opened, deleted]

project_column

Executa o fluxo de trabalho sempre que o evento project_column ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Colunas do projeto".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

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

Executa o fluxo de trabalho sempre que alguém torna público um repositório privado, o que aciona o evento public. Para obter informações sobre a API REST, consulte "Editar repositórios".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

on:
  public

pull_request

Executa o fluxo de trabalho sempre que o evento pull_request ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Pull requests".

Observação: por padrão, um fluxo de trabalho só é executado quando o tipo de atividade de uma pull_request é opened, synchronize ou reopened. Para acionar fluxos de trabalho para mais tipos de atividade, use a palavra-chave types.

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

É possível estender ou limitar os tipos de atividade padrão usando a palavra-chave types. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

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

on:
  pull_request:
    types: [assigned, opened, synchronize, reopened]
Eventos de pull request para repositórios bifurcados

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.

Quando você cria uma pull request a partir de um repositório bifurcado para o repositório base, o GitHub envia o evento de pull_request para o repositório base e nenhum evento de pull request acontecerá no repositório bifurcado.

Fluxos de trabalho não são executados em repositórios bifurcados por padrão. Você deve habilitar o GitHub Actions na aba Actions (Ações) do repositório bifurcado.

As permissões para o GITHUB_TOKEN em repositórios bifurcados são somente leitura. Para obter mais informações, consulte "Autenticação com o GITHUB_TOKEN".

pull_request_review

Executa o fluxo de trabalho sempre que o evento pull_request_review ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Revisões de pull request".

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

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

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]
Eventos de pull request para repositórios bifurcados

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.

Quando você cria uma pull request a partir de um repositório bifurcado para o repositório base, o GitHub envia o evento de pull_request para o repositório base e nenhum evento de pull request acontecerá no repositório bifurcado.

Fluxos de trabalho não são executados em repositórios bifurcados por padrão. Você deve habilitar o GitHub Actions na aba Actions (Ações) do repositório bifurcado.

As permissões para o GITHUB_TOKEN em repositórios bifurcados são somente leitura. Para obter mais informações, consulte "Autenticação com o GITHUB_TOKEN".

pull_request_review_comment

Executa o fluxo de trabalho sempre que um comentário no diff unificado de uma pull request é modificado, o que aciona o evento pull_request_review_comment. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte Comentários da revisão.

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

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

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]
Eventos de pull request para repositórios bifurcados

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.

Quando você cria uma pull request a partir de um repositório bifurcado para o repositório base, o GitHub envia o evento de pull_request para o repositório base e nenhum evento de pull request acontecerá no repositório bifurcado.

Fluxos de trabalho não são executados em repositórios bifurcados por padrão. Você deve habilitar o GitHub Actions na aba Actions (Ações) do repositório bifurcado.

As permissões para o GITHUB_TOKEN em repositórios bifurcados são somente leitura. Para obter mais informações, consulte "Autenticação com o GITHUB_TOKEN".

pull_request_target

Este evento é semelhante ao pull_request, exceto que é executado no contexto do repositório-base do pull request, em vez de ser executado no commit de merge. Isso significa que você pode disponibilizar os seus segredos de forma mais segura nos fluxos de trabalho acionados pelo pull request, porque apenas os fluxos de trabalho definidos no commit no repositório-base são executados. Por exemplo, este evento permite que você crie fluxos de trabalho que etiquetam e façam comentários em pull requests, com base no conteúdo da carga do evento.

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

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. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

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]

push

Observação: a carga de webhook disponível para o GitHub Actions não inclui os atributos added, removed e modified no objeto commit. É possível recuperar o objeto de commit completo usando a API REST. Para obter mais informações, consulte "Obter um único commit"".

Executa o fluxo de trabalho quando alguém faz push em um branch de repositório, o que aciona o evento 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

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

on:
  push

registry_package

Executa o seu fluxo de trabalho sempre que um pacote for publicado ou atualizado. Para obter mais informações, consulte "Gerenciando pacotes com o GitHub Package Registry".

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

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

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

em:
  registry_package:
    tipos: [published]

versão

Observação: O evento versão não é acionado para versões de rascunho.

Executa o fluxo de trabalho sempre que o evento release ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Versões".

Carga de evento webhookTipos de atividadeGITHUB_SHAGITHUB_REF
versão- publicado
- não publicado
- criado
- editado
- excluído
- pré-lançado
- lançado
Último commit na versão com tagTag da versão

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

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

on:
  release:
    types: [published]

status

Executa o fluxo de trabalho sempre que o status de um commit do Git muda, o que aciona o evento status. Para obter informações sobre a API REST, consulte Status.

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

on:
  status

inspecionar

Executa o fluxo de trabalho sempre que o evento watch ocorre. Mais de um tipo de atividade aciona este evento. Para obter informações sobre a API REST, consulte "Marcar com uma estrela".

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou branch padrão.

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

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

Por exemplo, você pode executar um fluxo de trabalho quando alguém marca um repositório com estrela, que é o tipo de atividade started que aciona o evento de inspeção.

on:
  watch:
    types: [started]

workflow_run

This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. For example, if your pull_request workflow generates build artifacts, you can create a new workflow that uses workflow_run to analyze the results and add a comment to the original pull request.

The workflow started by the workflow_run event is able to access the secrets and write tokens used by the original workflow.

Se precisar filtrar os branches desse evento, você poderá usar branches ou branches-ignore.

Neste exemplo, um fluxo de trabalho está configurado para ser executado separadamente após o fluxo de trabalho "Executar testes".

on:
  workflow_run:
    workflows: ["Run Tests"]
    branches: [main]
    types: 
      - completed
      - requested

Eventos programados

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

schedule

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

You can schedule a workflow to run at specific UTC times using POSIX cron syntax. Scheduled workflows run on the latest commit on the default or base branch. O intervalo mais curto que você pode executar fluxos de trabalho programados é uma vez a cada 5 minutos.

This example triggers the workflow every 15 minutes:

on:
  schedule:
    # * is a special character in YAML so you have to quote this string
    - cron:  '*/15 * * * *'

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

┌───────────── minuto (0 - 59)
│ ┌───────────── hora (0 - 23)
│ │ ┌───────────── dia do mês (1 - 31)
│ │ │ ┌───────────── mês (1 - 12 ou JAN-DEZ)
│ │ │ │ ┌───────────── dia da semana (0 - 6 ou DOM-SAB)
│ │ │ │ │                                   
│ │ │ │ │
│ │ │ │ │
* * * * *

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

OperadorDescriçãoExemplo
*Qualquer valor* * * * * executa cada minuto de 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 valores0 4-6 * * * executa no minuto 0 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.

Eventos manuais

Você pode acionar as execuções de fluxo de trabalho manualmente. Para acionar fluxos de trabalho específicos em um repositório, use o evento workflow_dispatch. Para acionar mais de um fluxo de trabalho em um repositório e criar eventos personalizados e tipos de eventos, use o evento repository_dispatch.

workflow_dispatch

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

Você pode acionar manualmente uma execução de fluxo de trabalho usando a API do GitHub e do GitHub. Para acionar o evento do webhook workflow_dispatch usando a API REST, você deve enviar uma solicitação POST para um ponto de extremidade da API do GitHub e fornecer o ref e qualquer entrada necessária. Para obter mais informações, consulte o ponto de extremidade da API REST "Criar um evento de envio de fluxo de trabalho".

Ao ativar o evento em GitHub, você poderá fornecer a ref e quaisquer entradas diretamente no GitHub. Para obter mais informações, consulte "Configurar fluxo de trabalho."

repository_dispatch

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

Nota: Este evento acionará apenas a execução de um fluxo de trabalho se o arquivo de trabalho estiver no master ou 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 despacho de repositório."

Para acionar o evento webhook repository_dispatch personalizado, envie uma solicitação POST para um ponto de extremidade da API do GitHub e forneça um nome de event_type para descrever o tipo de atividade. Para acionar a execução de um fluxo de trabalho, configure também o fluxo de trabalho para usar o evento repository_dispatch.

Exemplo

Por padrão, todos os event_types acionam a execução de um fluxo de trabalho. É possível limitar a execução do fluxo de trabalho quando um valor event_type específico for enviado na carga do webhook repository_dispatch. Você define os tipos de eventos enviados na carga repository_dispatch ao criar o evento de despacho de repositório.

em:
  repository_dispatch:
    tipos: [opened, deleted]

Acionar novos fluxos de trabalho usando um token de acesso pessoal

Quando você utiliza o GITHUB_TOKEN do repositório para executar tarefas em nome do aplicativo GitHub Actions , eventos acionados pelo GITHUB_TOKEN não criarão uma nova execução de fluxo de trabalho. Isso impede que você crie execuções de fluxo de trabalho recursivo. Por exemplo, se um fluxo de trabalho executar código pushes usando o GITHUB_TOKEN, um novo fluxo de trabalho não será executado mesmo quando o repositório contém um fluxo de trabalho configurado para ser executado quando ocorrerem eventos push. Para obter mais informações, consulte "Efetuando a autenticação com o GITHUB_TOKEN".

Se você deseja acionar um fluxo de trabalho a partir de uma execução do fluxo de trabalho, você pode acionar o evento usando um token de acesso pessoal. Você deverá criar um token de acesso pessoal e armazená-lo como um segredo. Para minimizar seus custos de uso GitHub Actions, certifique-se de que você não cria execução de fluxo de trabalho recursivo ou não intencional. Para obter mais informações, consulte "Criar e armazenar segredos encriptados".

Did this doc help you?