As verificações de status mostram se as confirmações atendem às condições definidas para um repositório. Eles geralmente são criados por sistemas externos, como builds de integração contínua, testes, verificação de código ou verificações de implantação.
Verificações de status ajudam revisores e mantenedores a entender se uma solicitação de pull está pronta para mesclagem. Uma verificação pode mostrar que o trabalho ainda está em execução, que as alterações passaram na validação ou que algo precisa de atenção.
Qualquer pessoa com permissão de gravação em um repositório pode configurar o estado de qualquer verificação de status no repositório.
Se as verificações de status forem necessárias para um branch protegido, elas deverão ser aprovadas antes que a solicitação de pull possa ser mesclada. Consulte Sobre branches protegidos.
Observação
Um trabalho ignorado relatará o respectivo status como "Success". Ele não impedirá a mesclagem de uma solicitação de pull, mesmo que seja uma verificação necessária.
Tipos de verificações de status em GitHub
Há dois tipos de verificações de status em GitHub:
| Tipo | Nível de detalhe | Criado por |
|---|---|---|
| Verificações | Saída detalhada, anotações e mensagens. | |
| GitHub Apps, incluindo GitHub Actions. | ||
| Status de commit | Um status mais simples para uma confirmação. | Serviços externos e integrações. |
Observação
GitHub Actions gera verificações, não status de confirmação, quando fluxos de trabalho são executados.
Os proprietários e usuários da organização com acesso por push a um repositório podem criar verificações e status de confirmação com GitHuba API . Confira Pontos de extremidade da API REST para verificações e Pontos de extremidade da API REST para status de commits.
Verificações
As verificações podem incluir logs de build, resultados de teste, anotações e links para mais detalhes. Em uma solicitação de pull, a guia Verificações ajuda você a entender quais validações foram executadas e por que uma verificação foi aprovada ou falhou.
Observação
A guia Verificações é preenchida para solicitações de pull somente se você configurar verificações, não status de confirmação, para o repositório.
Quando uma verificação aponta para uma linha específica, os detalhes também podem aparecer na guia Arquivos da solicitação de pull. Isso ajuda os revisores a conectar comentários automatizados ao código que está sendo alterado.
Ignorar e solicitar verificações para commits individuais
Alguns repositórios permitem que as verificações sejam ignoradas ou solicitadas para confirmações individuais. Isso pode ser útil quando uma verificação não é relevante para uma alteração específica ou quando as verificações não são solicitadas automaticamente.
Para GitHub Actions fluxos de trabalho, você pode ignorar as push execuções de fluxo de trabalho disparadas pelo e pull_request os eventos, incluindo uma instrução skip em sua mensagem de confirmação. Consulte Ignorar execuções de fluxo de trabalho.
Como alternativa, para ignorar ou solicitar todas as verificações do commit, adicione uma das seguintes linhas de trailer ao fim da mensagem de commit:
-
Para ignorar as verificações de um commit, digite sua mensagem de commit e uma descrição curta e significativa das alterações. Após a descrição do commit, antes das aspas de fechamento, adicione duas linhas vazias seguidas de
skip-checks: true:$ git commit -m "Update README > > skip-checks: true" -
Para solicitar verificações para um commit, digite sua mensagem de commit e uma descrição curta e significativa das alterações. Após a descrição do commit, antes das aspas de fechamento, adicione duas linhas vazias seguidas de
request-checks: true:$ git commit -m "Refactor usability tests > > request-checks: true"
Por padrão, o Git remove automaticamente novas linhas consecutivas. Para deixar a mensagem de commit exatamente como você a inseriu, use a opção --cleanup=verbatim no commit. Para obter mais informações, confira --cleanup=<mode> na documentação do Git.
Verifique os status e conclusões
Verifica se os status são movidos à medida que são executados e, em seguida, recebem uma conclusão quando terminam. Alguns status não podem ser definidos manualmente e são reservados para GitHub Actions.
| Status | Description |
GitHub Actions Só? |
| --- | --- | --- |
| completed | A execução da verificação foi concluída e tem uma conclusão (veja abaixo). | No |
| expected | A execução da verificação está aguardando que um status seja relatado. | Sim |
| failure | Falha na execução da verificação. | No |
| in_progress | A execução da verificação está em andamento. | No |
| pending | A execução da verificação está no início da fila, mas o limite de concorrência baseada em grupo foi alcançado. | Sim |
| queued | A execução da verificação foi enfileirada. | No |
| requested | A execução de verificação foi criada, mas ainda não foi colocada na fila. | Sim |
| startup_failure | O conjunto de verificação falhou durante a inicialização. Esse status não se aplica a execuções de verificação. | Sim |
| waiting | A execução da verificação está aguardando que uma regra de proteção de implantação seja atendida. | Sim |
Quando uma verificação tem um status de completed, ela tem uma conclusão. Uma conclusão bem-sucedida geralmente significa que a verificação não bloqueia a mesclagem. Uma falha, um tempo limite ou uma conclusão necessária para a ação geralmente significa que alguém deve examinar os detalhes antes que a solicitação de pull possa se mesclar.
| Conclusion | Description |
|---|---|
action_required | A execução da verificação forneceu as ações necessárias após sua conclusão. Para obter mais informações, consulte Como usar a API REST para interagir com verificações. |
cancelled | A execução da verificação foi cancelada antes de ser concluída. |
failure | Falha na execução da verificação. |
neutral | A execução da verificação foi concluída com um resultado neutro. Isso é tratado como um sucesso para verificações dependentes em GitHub Actions. |
skipped | A execução da verificação foi ignorada. Isso é tratado como um sucesso para verificações dependentes em GitHub Actions. |
stale | A execução de verificação foi marcada como obsoleta porque GitHub demorou muito. |
success | A execução da verificação foi concluída com sucesso |
timed_out | A execução da verificação atingiu o tempo limite. |
Retenção de cheques
GitHub retém dados de verificação por 400 dias. Após esses 400 dias, os dados são arquivados. Dez dias após o arquivamento, os dados são excluídos permanentemente.
Para mesclar uma solicitação de pull com verificações necessárias e arquivadas, execute novamente as verificações.