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

Sobre acionadores de fluxo de trabalho

Os acionadores de fluxo de trabalho são eventos que fazem com que um fluxo de trabalho seja executado. Esses eventos podem ser:

  • Eventos que ocorrem no repositório do fluxo de trabalho
  • Eventos que ocorrem fora de GitHub Enterprise Cloud e acionam um evento repository_dispatch em GitHub Enterprise Cloud
  • Horários agendados
  • Manual

Por exemplo, você pode configurar o fluxo de trabalho para executar quando um push é feito no branch padrão do seu repositório, quando uma versão é criada, ou quando um problema é aberto.

Os gatilhos de fluxo de trabalho estão definidos com a chave on. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o 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. O evento tem um SHA de commit associado e um ref de Git.

  2. GitHub Enterprise Cloud pesquisa no diretório .github/workflows no seu repositório para arquivos de fluxo de trabalho que estão presentes no commit SHA ou no ref do Git do evento.

  3. A execução de um fluxo de trabalho é acionada para todos fluxos de trabalho com valores on: que correspondem ao evento de acionamento. Alguns eventos também exigem que o arquivo do fluxo de trabalho esteja presente no branch padrão do repositório para ser executado.

    Cada execução de fluxo de trabalho usará a versão do fluxo de trabalho que está presente no SHA do commit ou na ref do Git do evento. Quando um fluxo de trabalho é executado, o GitHub Enterprise Cloud 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".

Acionando um fluxo de trabalho a partir de um fluxo de trabalho

When you use the repository's GITHUB_TOKEN to perform tasks, events triggered by the GITHUB_TOKEN will not create a new workflow run. 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 de dentro de uma execução de fluxo de trabalho, você pode usar um token de acesso pessoal em vez de GITHUB_TOKEN para acionar eventos que exigem um token. 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 sobre a criação de um token de acesso pessoal, consulteCriando um token de acesso pessoal." Para mais informações sobre como armazenar um token de acesso pessoal como segredo, consulte "Criar e armazenar segredos criptografados".

Por exemplo, o fluxo de trabalho a seguir usa um token de acesso pessoal (armazenado como um segredo chamado MY_TOKEN) para adicionar uma etiqueta a um problema por meio de GitHub CLI. Todos os fluxos de trabalho que forem executados quando uma etiqueta é adicionada, serão executados assim que esta etapa for executada.

on:
  issues:
    types:
      - opened

jobs:
  label_issue:
    runs-on: ubuntu-latest
    steps:
      - env:
          GITHUB_TOKEN: ${{ secrets.MY_TOKEN }}
          ISSUE_URL: ${{ github.event.issue.html_url }}
        run: |
          gh issue edit $ISSUE_URL --add-label "triage"

Inversamente, o fluxo de trabalho a seguir usa GITHUB_TOKEN para adicionar uma etiqueta a um problema. Ele não acionará nenhum fluxo de trabalho executado quando uma etiqueta é adicionada.

on:
  issues:
    types:
      - opened

jobs:
  label_issue:
    runs-on: ubuntu-latest
    steps:
      - env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          ISSUE_URL: ${{ github.event.issue.html_url }}
        run: |
          gh issue edit $ISSUE_URL --add-label "triage"

Usando eventos para acionar fluxos de trabalho

Use a chave on para especificar quais eventos acionam o seu fluxo de trabalho. Para obter mais informações sobre eventos que você pode usar, consulte "Eventos disponíveis" abaixo.

Using a single event

For example, a workflow with the following on value will run when a push is made to any branch in the workflow's repository:

on: push

Using multiple events

You can specify a single event or multiple events. For example, a workflow with the following on value will run when a push is made to any branch in the repository or when someone forks the repository:

on: [push, fork]

If you specify multiple events, only one of those events needs to occur to trigger your workflow. If multiple triggering events for your workflow occur at the same time, multiple workflow runs will be triggered.

Using activity types

Some events have activity types that give you more control over when your workflow should run.

For example, the issue_comment event has the created, edited, and deleted activity types. If your workflow triggers on the label event, it will run whenever a label is created, edited, or deleted. If you specify the created activity type for the label event, your workflow will run when a label is created but not when a label is edited or deleted.

on:
  label:
    types:
      - created

If you specify multiple activity types, only one of those event activity types needs to occur to trigger your workflow. If multiple triggering event activity types for your workflow occur at the same time, multiple workflow runs will be triggered. For example, the following workflow triggers when an issue is opened or labeled. If an issue with two labels is opened, three workflow runs will start: one for the issue opened event and two for the two issue labeled events.

on:
  issue:
    types:
      - opened
      - labeled

Using filters

Some events have filters that give you more control over when your workflow should run.

For example, the push event has a branches filter that causes your workflow to run only when a push to a branch that matches the branches filter occurs, instead of when any push occurs.

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

Using activity types and filters with multiple events

If you specify activity types or filters for an event and your workflow triggers on multiple events, you must configure each event separately. Você deve anexar dois pontos (:) a todos os eventos, incluindo eventos sem configuração.

For example, a workflow with the following on value will run when:

  • A label is created
  • A push is made to the main branch in the repository
  • A push is made to a GitHub Pages-enabled branch
on:
  label:
    types:
      - created
  push:
    branches:
      - main
  page_build:

Usando informações do evento

As informações sobre o evento que desencadeou uma execução de fluxo de trabalho estão disponíveis no contexto github.event. As propriedades no contexto github.event dependem do tipo de evento que acionou o fluxo de trabalho. Por exemplo, um fluxo de trabalho acionado quando um problema está etiquetado teria informações sobre o problema e a etiqueta.

Visualizando todas as propriedades de um evento

Referência à documentação de evento de webhook para propriedades comuns e cargas de exemplo. Para obter mais informações, consulte "Eventos e cargas de Webhook".

Você também pode imprimir o contexto inteiro de github.event para ver quais propriedades estão disponíveis para o evento que acionou o seu fluxo de trabalho:

jobs:
  print_context:
    runs-on: ubuntu-latest
    steps:
      - env:
          EVENT_CONTEXT: ${{ toJSON(github.event) }}
        run: |
          echo $EVENT_CONTEXT

Acessando e usando as propriedades do evento

Você pode usar o contexto github.event no fluxo de trabalho. Por exemplo, o fluxo de trabalho a seguir é executado quando um pull request que muda package*.json, .github/CODEOWNERS ou .github/workflows/** é aberto. Se o autor do pull request (github.event.pull_request.user.login) não for octobot ou dependabot[bot], o fluxo de trabalho usará o GitHub CLI para etiquetar e comentar no pull request (github.event.pull_request.number).

on:
  pull_request:
    types:
      - opened
    paths:
      - '.github/workflows/**'
      - '.github/CODEOWNERS'
      - 'package*.json'

jobs:
  triage:
    if: >-
      github.event.pull_request.user.login != 'octobot' &&
      github.event.pull_request.user.login != 'dependabot[bot]'
    runs-on: ubuntu-latest
    steps:
      - name: "Comment about changes we can't accept"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          PR: ${{ github.event.pull_request.html_url }}
        run: |
          gh pr edit $PR --add-label 'invalid'
          gh pr comment $PR --body 'It looks like you edited `package*.json`, `.github/CODEOWNERS`, or `.github/workflows/**`. Nós não permitimos contribuições para esses arquivos. Consulte nossas [diretrizes de contribuição](https://github.com/octo-org/octo-repo/blob/main/CONTRIBUTING.md) para saber quais contribuições são aceitas.'

Para obter mais informações sobre os contextos, consulte "Contextos". Para obter mais informações sobre cargas de eventos, consulte "Eventos Webhook e cargas".

Controlando ainda mais como seu fluxo de trabalho será executado

If you want more granular control than events, event activity types, or event filters provide, you can use conditionals and environments to control whether individual jobs or steps in your workflow will run.

Usando condicionais

Você pode usar condicionais para controlar ainda mais se os trabalhos ou etapas no seu fluxo de trabalho serão executados. Se você quiser, por exemplo, que o fluxo de trabalho seja executado quando uma etiqueta específica for adicionada a um problema, você poderá acionar o tipo de atividade do evento issues labeled e usar uma condicional para verificar qual etiqueta acionou o fluxo de trabalho. O fluxo de trabalho a seguir será executado quando qualquer etiqueta for adicionada a um problema no repositório do fluxo de trabalho, mas a o trabalho run_if_label_matches só será executado se a etiqueta tiver o nome de bug.

on:
  issues:
    types:
      - labeled

jobs:
  run_if_label_matches:
    if: github.event.label.name == 'bug'
    runs-on: ubuntu-latest
    steps:
      - run: echo 'The label was bug'

Para obter mais informações, consulte "Expressões".

Usando ambientes para acionar trabalhos de fluxo de trabalho manualmente

Se você quiser acionar manualmente uma tarefa específica em um fluxo de trabalho, você pode usar um ambiente que exige a aprovação de uma equipe ou usuário específico. Primeiro, configure um ambiente com os revisores necessários. Para obter mais informações, consulte "Usando ambientes para implantação". Em seguida, faça referência ao nome do ambiente em um trabalho no seu fluxo de trabalho usando o a chave environment:. Qualquer trabalho que faz referência ao ambiente não será executado até que pelo menos um revisor aprove o trabalho.

Por exemplo, o seguinte fluxo de trabalho será executado sempre que houver um push para o principal. O trabalho build sempre será executado. The publish job will only run after the build job successfully completes (due to needs: [build]) and after all of the rules (including required reviewers) for the environment called production pass (due to environment: production).

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: build
        echo 'building'

  publish:
    needs: [build]
    runs-on: ubuntu-latest
    environment: production
    steps:
      - name: publish
        echo 'publishing'

Environments, environment protection rules, and environment secrets are available in public repositories for all products. For access to environments in private repositories, you must use GitHub Enterprise. Para obter mais informações, consulte os "produtos do GitHub".

Eventos disponíveis

Alguns eventos têm vários tipos de atividades. Para esses eventos, você pode especificar quais tipos de atividade ativarão a execução de um fluxo de trabalho. Para obter mais informações sobre o significado de cada tipo de atividade, consulte "Eventos de webhook e cargas". Observe que nem todos os eventos de webhook acionam fluxos de trabalho.

branch_protection_rule

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

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

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

Executa o fluxo de trabalho quando as regras de proteção de branch no repositório do fluxo de trabalho são alteradas. Para obter mais informações sobre as regras de proteção de branches, consulte "Sobre branches protegidos". Para informações sobre as APIs das regras de proteção de branch, consulte "BranchProtectionRule" na documentação da API do GraphQL ou "Branches" na documentação da API REST.

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

on:
  branch_protection_rule:
    types: [created, deleted]

check_run

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

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

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

Executa o fluxo de trabalho quando ocorre a atividade relacionada a uma execução de verificação. Uma execução de verificação é um teste individual que faz parte de um conjunto de verificações. Para obter informações, consulte "Primeiros passos com a API de Verificações". Para informações sobre as APIs de verificação, consulte "CheckRun" na documentação da API do GraphQL ou "Verificações" na documentação da API REST.

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

on:
  check_run:
    types: [rerequested, completed]

check_suite

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

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

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

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

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

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

on:
  check_suite:
    types: [completed]

create

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

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

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

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

on:
  create

delete

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

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

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

Executa o fluxo de trabalho quando alguém exclui uma referência Git (branch ou tag) no repositório do fluxo de trabalho. For information about the APIs to delete a Git reference, see "deleteRef" in the GraphQL API documentation or "Delete a reference" in the REST API documentation.

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. For information about the APIs to create a deployment status, see "createDeploymentStatus" in the GraphQL API documentation or "Create a deployment status" in the REST API documentation.

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

on:
  deployment_status

discussão

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

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

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

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

Runs your workflow when a discussion in the workflow's repository is created or modified. Para atividade relacionada a comentários em uma discussão, use o evento discussion_comment. For more information about discussions, see "About discussions." For information about the GraphQL API, see "Discussion."

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

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

discussion_comment

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

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

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

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

Runs your workflow when a comment on a discussion in the workflow's repository is created or modified. For activity related to a discussion as opposed to comments on the discussion, use the discussion event. For more information about discussions, see "About discussions." For information about the GraphQL API, see "Discussion."

For example, you can run a workflow when a discussion comment has been created or deleted.

on:
  discussion_comment:
    types: [created, deleted]

bifurcação

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

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

Runs your workflow when someone forks a repository. 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.

Runs your workflow when someone creates or updates a Wiki page. 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

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

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

Runs your workflow when an issue or pull request comment is created, edited, or deleted. For information about the issue comment APIs, see "IssueComment" in the GraphQL API documentation or "Issue comments" in the REST API documentation.

For example, you can run a workflow when an issue or pull request comment has been created or deleted.

on:
  issue_comment:
    types: [created, deleted]

issue_comment on issues only or pull requests only

O evento issue_comment ocorre para comentários em ambos os problemas e pull requests. You can use the github.event.issue.pull_request property in a conditional to take different action depending on whether the triggering object was an issue or pull request.

For example, this workflow will run the pr_commented job only if the issue_comment event originated from a pull request. It will run the issue_commented job only if the issue_comment event originated from an issue.

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

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

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

Runs your workflow when an issue in the workflow's repository is created or modified. For activity related to comments in an issue, use the issue_comment event. Para obter mais informações sobre os problemas, consulte "Sobre os problemas". For information about the issue APIs, see "Issue" in the GraphQL API documentation or "Issues" in the REST API documentation.

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

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

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

Runs your workflow when a label in your workflow's repository is created or modified. For more information about labels, see "Managing labels." For information about the label APIs, see "Label" in the GraphQL API documentation or "Labels" in the REST API documentation.

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

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

on:
  label:
    types: [created, deleted]

marco

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

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

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

Runs your workflow when a milestone in the workflow's repository is created or modified. For more information about milestones, see "About milestones." For information about the milestone APIs, see "Milestone" in the GraphQL API documentation or "Milestones" in the REST API documentation.

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

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

on:
  milestone:
    types: [opened, deleted]

page_build

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

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

Runs your workflow when someone pushes to a branch that is the publishing source for GitHub Pages, if GitHub Pages is enabled for the repository. For more information about GitHub Pages publishing sources, see "Configuring a publishing source for your GitHub Pages site." 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

Note: Mais de um tipo de atividade aciona este evento. The edited activity type refers to when a project board, not a column or card on the project board, is edited. For information about each activity type, see "Webhook events and payloads." Por padrão, todos os tipos de atividade ativam a execução de um fluxo de trabalho. Você pode limitar a execução do fluxo de trabalho para determinados tipos de atividade usando a palavra-chave types (tipos). Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

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

Note: This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository.

Note: This event does not occur for projects (beta). For more information, see "About projects (beta)."

Runs your workflow when a project board is created or modified. For activity related to cards or columns in a project board, use the project_card or project_column events instead. For more information about project boards, see "About project boards." For information about the project board APIs, see "Project" in the GraphQL API documentation or "Projects" in the REST API documentation.

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

on:
  project:
    types: [created, deleted]

project_card

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

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

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

Note: This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository.

Note: This event does not occur for projects (beta). For more information, see "About projects (beta)."

Executa o fluxo de trabalho quando um cartão em um quadro de projeto é criado ou modificado. Para atividade relacionada aos quadros ou colunas do projeto em um quadro de projeto, use o evento projeto ou projeto_column. For more information about project boards, see "About project boards." For information about the project card APIs, see "ProjectCard" in the GraphQL API documentation or "Project cards" in the REST API documentation.

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

on:
  project_card:
    types: [created, deleted]

project_column

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

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

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

Note: This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository.

Note: This event does not occur for projects (beta). For more information, see "About projects (beta)."

Executa o fluxo de trabalho quando uma coluna em um quadro de projeto é criada ou modificada. Para a atividade relacionada a quadros de projetos ou cartões em um quadro de projeto, use o evento projeto ou project_card. For more information about project boards, see "About project boards." 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

Note: Mais de um tipo de atividade aciona este evento. For information about each activity type, see "Webhook events and payloads." By default, a workflow only runs when a pull_request event's activity type is opened, synchronize, or reopened. You can specify different activity types using the types keyword. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Note: By default, only the opened, synchronize, and reopened activity types trigger workflows that run on the pull_request event. To trigger workflows by different activity types, use the types keyword.

Note: Workflows will not run on pull_request activity if the pull request has a merge conflict. O conflito de merge tem de ser resolvido primeiro.

Conversely, workflows with the pull_request_target event will run even if the pull request has a merge conflict. Before using the pull_request_target trigger, you should be aware of the security risks. For more information, see pull_request_target.

Runs your workflow when activity on a pull request in the workflow's repository occurs. For example, if no activity types are specified, the workflow runs when a pull request is opened or reopened or when the head branch of the pull request is updated. For activity related to pull request reviews, pull request review comments, or pull request comments, use the pull_request_review, pull_request_review_comment, or issue_comment events instead. For information about the pull request APIs, see "PullRequest" in the GraphQL API documentation or "Pull requests" in the REST API documentation.

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

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

on:
  pull_request:
    types: [opened, reopened]

You can use the event context to further control when jobs in your workflow will run. For example, this workflow will run when a review is requested on a pull request, but the specific_review_requested job will only run when a review by octo-team is requested.

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

Running your workflow based on the head or base branch of a pull request

You can use the branches or branches-ignore filter to configure your workflow to only run on pull requests that target specific branches. For more information, see "Workflow syntax for GitHub Actions."

For example, this workflow will run when someone opens a pull request that targets a branch whose name starts with releases/:

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

Note: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. For example, the following workflow will only run when a pull request that includes a change to a JavaScript (.js) file is opened on a branch whose name starts with releases/:

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

To run a job based on the pull request's head branch name (as opposed to the pull request's base branch name), use the github.head_ref context in a conditional. For example, this workflow will run whenever a pull request is opened, but the run_if job will only execute if the head of the pull request is a branch whose name starts with 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/'"

Running your workflow based on files changed in a pull request

You can also configure your workflow to run when a pull request changes specific files. For more information, see "Workflow syntax for GitHub Actions."

For example, this workflow will run when a pull request includes a change to a JavaScript file (.js):

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

Note: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. For example, the following workflow will only run when a pull request that includes a change to a JavaScript (.js) file is opened on a branch whose name starts with releases/:

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

Workflows in forked repositories

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

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

Eventos de pull request para repositórios bifurcados

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

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

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

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

pull_request_comment (use issue_comment)

To run your workflow when a comment on a pull request (not on a pull request's diff) is created, edited, or deleted, use the issue_comment event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events.

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

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

Runs your workflow when a pull request review is submitted, edited, or dismissed. A pull request review is a group of pull request review comments in addition to a body comment and a state. For activity related to pull request review comments or pull request comments, use the pull_request_review_comment or issue_comment events instead. For information about the pull request review APIs, see "PullRequestReview" in the GraphQL API documentation or "Pull request reviews" in the REST API documentation.

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

on:
  pull_request_review:
    types: [edited, dismissed]

Running a workflow when a pull request is approved

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

on:
  pull_request_review:
    types: [submitted]

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

Workflows in forked repositories

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

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

Eventos de pull request para repositórios bifurcados

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

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

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

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

pull_request_review_comment

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

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

Runs your workflow when a pull request review comment is modified. A pull request review comment is a comment on a pull request's diff. For activity related to pull request reviews or pull request comments, use the pull_request_review or issue_comment events instead. For information about the pull request review comment APIs, see "PullRequestReviewComment" in the GraphQL API documentation or "Review comments" in the REST API documentation.

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 Cloud sends the pull_request, issue_comment, pull_request_review_comment, pull_request_review, and pull_request_target events to the base repository. No pull request events occur on the forked repository.

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

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

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

pull_request_target

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

Note: Mais de um tipo de atividade aciona este evento. For information about each activity type, see "Webhook events and payloads." 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. You can specify different activity types using the types keyword. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Note: By default, only the opened, synchronize, and reopened activity types trigger workflows that run on the pull_request event. To trigger workflows by different activity types, use the types keyword.

Runs your workflow when activity on a pull request in the workflow's repository occurs. For example, if no activity types are specified, the workflow runs when a pull request is opened or reopened or when the head branch of the pull request is updated.

This event runs in the context of the base of the pull request, rather than in the context of the merge commit, as the pull_request event does. This prevents execution of unsafe code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows your workflow to do things like label or comment on pull requests from forks. Avoid using this event if you need to build or run code from the pull request.

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

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

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

Running your workflow based on the head or base branch of a pull request

You can use the branches or branches-ignore filter to configure your workflow to only run on pull requests that target specific branches. For more information, see "Workflow syntax for GitHub Actions."

For example, this workflow will run when someone opens a pull request that targets a branch whose name starts with releases/:

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

Note: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. For example, the following workflow will only run when a pull request that includes a change to a JavaScript (.js) file is opened on a branch whose name starts with releases/:

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

To run a job based on the pull request's head branch name (as opposed to the pull request's base branch name), use the github.head_ref context in a conditional. For example, this workflow will run whenever a pull request is opened, but the run_if job will only execute if the head of the pull request is a branch whose name starts with 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/'"

Running your workflow based on files changed in a pull request

You can use the paths or paths-ignore filter to configure your workflow to run when a pull request changes specific files. For more information, see "Workflow syntax for GitHub Actions."

For example, this workflow will run when a pull request includes a change to a JavaScript file (.js):

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

Note: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. For example, the following workflow will only run when a pull request that includes a change to a JavaScript (.js) file is opened on a branch whose name starts with releases/:

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

push

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

Observação: a carga de webhook disponível para o GitHub Actions não inclui os atributos added, removed e modified no objeto commit. You can retrieve the full commit object using the API. For information, see "Commit" in the GraphQL API documentation or "Get a commit" in the REST API documentation.

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

Runs your workflow when you push a commit or tag.

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

on:
  push

Running your workflow only when a push to specific branches occurs

You can use the branches or branches-ignore filter to configure your workflow to only run when specific branches are pushed. For more information, see "Workflow syntax for GitHub Actions."

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

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

Note: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. For example, the following workflow will only run when a push that includes a change to a JavaScript (.js) file is made to a branch whose name starts with releases/:

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

Running your workflow only when a push of specific tags occurs

You can use the tags or tags-ignore filter to configure your workflow to only run when specific tags or are pushed. For more information, see "Workflow syntax for GitHub Actions."

For example, this workflow will run when someone pushes a tag that starts with v1..

on:
  push:
    tags:        
      - v1.**

Running your workflow only when a push affects specific files

You can use the paths or paths-ignore filter to configure your workflow to run when a push to specific files occurs. For more information, see "Workflow syntax for GitHub Actions."

For example, this workflow will run when someone pushes a change to a JavaScript file (.js):

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

Note: If you use both the branches filter and the paths filter, the workflow will only run when both filters are satisfied. For example, the following workflow will only run when a push that includes a change to a JavaScript (.js) file is made to a branch whose name starts with releases/:

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

registry_package

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

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

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

Runs your workflow when activity related to GitHub Package Registry occurs in your repository. For more information, see "GitHub Package Registry Documentation."

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

em:
  registry_package:
    tipos: [published]

versão

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

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

Note: Workflows are not triggered for the created, edited, or deleted activity types for draft releases. When you create your release through the GitHub Enterprise Cloud browser UI, your release may automatically be saved as a draft.

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.

Runs your workflow when release activity in your repository occurs. For information about the release APIs, see "Release" in the GraphQL API documentation or "Releases" in the REST API documentation.

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

on:
  release:
    types: [published]

repository_dispatch

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

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

You can use the GitHub Enterprise Cloud API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub Enterprise Cloud. Para obter mais informações, consulte "Criar um evento de envio do repositório".

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

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

Any data that you send through the client_payload parameter will be available in the github.event context in your workflow. For example, if you send this request body when you create a repository dispatch event:

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

then you can access the payload in a workflow like this:

on:
  repository_dispatch:
    types: [test_result]

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

schedule

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

status

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

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

Runs your workflow when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. If you want to provide more details about the status change, you may want to use the check_run event. For information about the commit status APIs, see "Status" in the GraphQL API documentation or "Statuses" in the REST API documentation.

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

on:
  status

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

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

inspecionar

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

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

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

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

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

on:
  watch:
    types: [started]

workflow_call

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

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

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

on: workflow_call

workflow_dispatch

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

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

on: workflow_dispatch

Providing inputs

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

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

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

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

If you run this workflow from a browser you must enter values for the required inputs manually before the workflow will run.

Entering inputs for a workflow

You can also pass inputs when you run a workflow from a script, or by using GitHub CLI. Por exemplo:

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

For more information, see the GitHub CLI information in "Manually running a workflow."

workflow_run

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

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

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

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

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

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

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

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

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

Running a workflow based on the conclusion of another workflow

A workflow run is triggered regardless of the conclusion of the previous workflow. If you want to run a job or step based on the result of the triggering workflow, you can use a conditional with the github.event.workflow_run.conclusion property. For example, this workflow will run whenever a workflow named "Build" completes, but the on-success job will only run if the "Build" workflow succeeded, and the on-failure job will only run if the "Build" workflow failed:

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

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

Limiting your workflow to run based on branches

You can use the branches or branches-ignore filter to specify what branches the triggering workflow must run on in order to trigger your workflow. For more information, see "Workflow syntax for GitHub Actions." For example, a workflow with the following trigger will only run when the workflow named Build runs on a branch named canary.

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

Using data from the triggering workflow

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

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

name: Upload data

on:
  pull_request:

jobs:
  upload:
    runs-on: ubuntu-latest

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

When a run of the above workflow completes, it triggers a run of the following workflow. The following workflow uses the github.event.workflow_run context and the GitHub Enterprise Cloud REST API to download the artifact that was uploaded by the above workflow, unzips the downloaded artifact, and comments on the pull request whose number was uploaded as an artifact.

name: Use the data

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

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

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

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