Skip to main content

Adicionar um selo de status de fluxo de trabalho

Você pode exibir um selo de status no seu repositório para indicar o status dos seus fluxos de trabalho.

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

Observação: as notificações de fluxo de trabalho em um repositório privado não podem ser acessados ​​externamente, portanto, você não poderá incorporar ou vinculá-los a partir de um site externo.

Um selo de status mostra se um fluxo de trabalho está falhando ou passando. Um local comum para adicionar uma notificação de status é no arquivo README.md do repositório, mas você pode adicioná-lo a qualquer página da Web desejada. Por padrão, os selos exibem o status do seu branch-padrão. Você também pode exibir o status de uma execução de fluxo de trabalho para um branch ou um evento específico usando os parâmetros de consulta branch e event na URL.

exemplo de selo de status

Para adicionar uma notificação de status de fluxo de trabalho ao arquivo README.md, primeiro localize a URL da notificação de status que você gostaria de exibir. Em seguida, você pode usar o Markdown para exibir a notificação como uma imagem em seu arquivo README.md. Para obter mais informações sobre a marcação de imagem no Markdown, confira "Sintaxe básica de escrita e formatação".

Usar o nome do arquivo do fluxo de trabalho

Você pode criar a URL para uma notificação de status de fluxo de trabalho usando o nome do arquivo de fluxo de trabalho:

<HOSTNAME>/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE>/badge.svg

Para exibir a notificação de status do fluxo de trabalho em seu arquivo README.md, use a marcação do Markdown para inserir imagens. Para obter mais informações sobre a marcação de imagem no Markdown, confira "Sintaxe básica de escrita e formatação".

Por exemplo, adicione o Markdown a seguir ao arquivo README.md para adicionar uma notificação de status para um fluxo de trabalho com o caminho do arquivo .github/workflows/main.yml. O OWNER do repositório é a organização github, e o nome do REPOSITORY é docs.

![example workflow](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)

Como usar o parâmetro branch

Para exibir o status de uma execução de fluxo de trabalho para um branch específico, adicione ?branch=<BRANCH_NAME> ao final da URL da notificação de status.

Por exemplo, adicione o Markdown a seguir ao arquivo README.md para adicionar uma notificação de status para uma marcação com o nome feature-1.

![example branch parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?branch=feature-1)

Como usar o parâmetro event

Para exibir o status das execuções de fluxo de trabalho disparadas pelo evento push, adicione ?event=push ao final da URL da notificação de status.

Por exemplo, adicione o seguinte Markdown ao seu arquivo README.md para exibir uma notificação com o status das execuções de fluxo de trabalho acionadas pelo evento push, que mostrará o status do build para o estado atual desse branch.

![example event parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?event=push)