O Que É o Evento workflow_dispatch no GitHub Actions?

O evento workflow_dispatch permite iniciar um workflow manualmente pela aba Actions ou pela API, com inputs opcionais.

Nem todo workflow deve executar automaticamente. O gatilho workflow_dispatch adiciona um botão "Run workflow" para que uma pessoa possa iniciar um job sob demanda, o que é ideal para deploys e tarefas pontuais de manutenção.

O que é

Um gatilho que expõe um botão de execução manual na UI do GitHub e um endpoint da API REST. Ele pode declarar inputs tipados que o operador preenche no momento da execução.

Manual trigger with inputs

on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Target environment'
        type: choice
        options: [staging, production]

Como funciona

Uma vez que um workflow com workflow_dispatch esteja na branch padrão, o GitHub mostra um controle "Run workflow". Os inputs selecionados ficam disponíveis no workflow como ${{ inputs.<name> }}.

Usos comuns

Disparar deploys para um ambiente escolhido.
Executar jobs de manutenção ou migração ad hoc.
Reexecutar um pipeline com parâmetros diferentes.

Por que importa

O disparo manual oferece automação controlada e sob demanda sem precisar commitar código descartável. Inputs tipados tornam essas execuções seguras e autodocumentadas.

Conceitos relacionados

Ele é um dos muitos gatilhos e costuma ser combinado com ambientes e deployments para releases protegidos.

Principais conclusões

workflow_dispatch habilita execuções manuais.
Ele pode declarar inputs tipados lidos via ${{ inputs.x }}.
O workflow precisa estar na branch padrão para aparecer.

Guias relacionados

What Is a Workflow Trigger in GitHub Actions?A workflow trigger is the event that starts a GitHub Actions workflow. Triggers are declared in the on key, s… What Is an Environment in GitHub Actions?An environment in GitHub Actions is a named deployment target like staging or production, with its own secret… What Is a Deployment in GitHub Actions?A deployment in GitHub Actions is a tracked release to an environment, recording status and history so you ca… What Is a Context in GitHub Actions?A context in GitHub Actions is a structured object of run data, like github, env, and secrets, that you read…