Executar um fluxo de trabalho manualmente

Quando um fluxo de trabalho é configurado para ser executado no evento workflow_dispatch, você pode executar o fluxo de trabalho usando a guia Ações no GitHub, a GitHub CLI ou a API REST.

Tool navigation

Neste artigo

Note

No momento, não há suporte para executores hospedados no GitHub no GitHub Enterprise Server. Você pode ver mais informações sobre o suporte futuro planejado no GitHub public roadmap.

Configurar um fluxo de trabalho para ser executado manualmente

Para executar um fluxo de trabalho manualmente, o fluxo de trabalho precisa ser configurado para ser executado no evento workflow_dispatch.

Para disparar o evento workflow_dispatch, seu fluxo de trabalho precisa estar no branch padrão. Para saber mais sobre a configuração do evento workflow_dispatch, confira Eventos que disparam fluxos de trabalho.

É necessário o acesso de gravação ao repositório é para executar essas etapas.

Executando um fluxo de trabalho

  1. Em GitHub, acesse a página principal do repositório.

  2. No nome do repositório, clique em Ações.

    Captura de tela das guias do repositório "github/docs". A guia "Ações" está realçada com um contorno laranja.

  3. Na barra lateral esquerda, clique no nome do fluxo de trabalho que deseja executar.

    Captura de tela da página "Ações". Na barra lateral esquerda, o nome do fluxo de trabalho está realçado com um contorno em laranja escuro.

  4. Clique no botão Executar fluxo de trabalho, que fica acima da lista de execuções de fluxo de trabalho.

    Note

    Para você ver o botão Run workflow, o arquivo de fluxo de trabalho precisa usar o gatilho de evento workflow_dispatch. Somente os arquivos de fluxo de trabalho que usam o gatilho do evento workflow_dispatch têm a opção de executar o fluxo de trabalho manualmente usando o botão Executar fluxo de trabalho. Para saber mais sobre a configuração do evento workflow_dispatch, confira Eventos que disparam fluxos de trabalho.

    Captura de tela da página de fluxo de trabalho. Acima da lista de execuções de fluxo de trabalho, o botão rotulado como "Executar fluxo de trabalho", está contornado em laranja escuro.

  5. Selecione o menu suspenso Branch e clique em um branch para executar o fluxo de trabalho.

  6. Se o fluxo de trabalho exigir entradas, preencha os campos.

  7. Clique em Executar fluxo de trabalho.

Note

Para saber mais sobre GitHub CLI, confira "Sobre o a CLI do GitHub".

Para executar um fluxo de trabalho, use o subcomando workflow run. Substitua o parâmetro workflow pelo nome, pela ID ou pelo nome do arquivo de fluxo de trabalho que deseja executar. Por exemplo, "Link Checker", 1234567 ou "link-check-test.yml". Se você não especificar um fluxo de trabalho, GitHub CLI irá retornar um menu interativo para você escolher um fluxo de trabalho.

gh workflow run WORKFLOW

Se o fluxo de trabalho aceitar entradas, GitHub CLI solicitará que você os insira. Como alternativa, você pode usar -f ou -F para adicionar uma entrada no formato key=value. Use -F para fazer a leitura de um arquivo.

gh workflow run greet.yml -f name=mona -f greeting=hello -F data=@myfile.txt

Você também pode passar as entradas como JSON usando a entrada padrão.

echo '{"name":"mona", "greeting":"hello"}' | gh workflow run greet.yml --json

Para executar um fluxo de trabalho em um branch que não seja o branch padrão do repositório, use o sinalizador --ref.

gh workflow run WORKFLOW --ref BRANCH

Para ver o progresso da execução do fluxo de trabalho, use o subcomando run watch e selecione a execução na lista interativa.

gh run watch

Executar um fluxo de trabalho usando a API REST

Ao usar a API REST, você configura os parâmetros do corpo da solicitação inputs e ref. Se as entradas forem omitidas, serão usados os valores-padrão definidos no arquivo de fluxo de trabalho.

Note

Você pode definir até 10 inputs para um evento workflow_dispatch.

Para saber mais sobre o uso da API REST, confira Pontos de extremidade da API REST para fluxos de trabalho.