A verificação HeyDeer Review
O HeyDeer publica cada revisão como uma verificação do GitHub chamada HeyDeer Review no commit revisado. A verificação traz o resumo e a revisão completa, e você pode exigi-la antes do merge.
O que a verificação mostra
A verificação mostra o andamento da revisão e termina com uma das conclusões abaixo. O link Details abre a revisão no HeyDeer.
O resumo começa com o número de problemas encontrados, de conversas anteriores não resolvidas e de verificações do repositório com falha, e informa se uma revisão de acompanhamento cobriu apenas as alterações desde a revisão anterior do HeyDeer. Em seguida, a página da verificação mostra a revisão completa: avisos, todos os problemas, preocupações recusadas na discussão e a decisão de aprovação quando Aprovação automática está ativada. Consulte Como ler uma revisão.
Conclusões
| Conclusão | Título | Quando |
|---|---|---|
| Sucesso | Review completed — no issues found / Review completed with findings | Nenhum problema, ou há problemas mas Reprovar a verificação quando forem encontrados problemas está desativado. |
| Neutra | Review completed with warnings / Review completed with findings | A revisão tem um aviso e a configuração está desativada. |
| Falha | Review found issues that need attention / Review incomplete | Problemas ou um aviso, com a configuração ativada. Review incomplete também aparece, independentemente da configuração, quando uma verificação do repositório ou um problema encontrado anteriormente não foi avaliado. |
| Falha | Review could not run / Review failed | O HeyDeer não conseguiu iniciar ou concluir a revisão. O resumo informa o motivo. |
| Tempo esgotado | Review timed out | A revisão excedeu o tempo limite. |
| Cancelada | Review cancelled / Review superseded | A revisão foi cancelada, ou o resultado é de um commit ou de uma branch de destino mais antigos. |
| Ignorada | Review skipped / No reviewable files | Seus filtros de revisão automática excluem o pull request (rascunhos, por padrão), ou todos os arquivos alterados estão fora do escopo da revisão. |
| Ignorada ou Ação necessária | Review skipped / Review required | O commit não foi revisado automaticamente, por exemplo com Somente manual, depois que Uma vez por PR usou sua revisão ou quando faltam créditos. A conclusão é Ação necessária quando a configuração está ativada. |
Quando um commit não foi revisado ou a revisão não terminou, o resumo informa o próximo passo, geralmente comentar @heydeer review.
Reprovar a verificação quando forem encontrados problemas
Essa configuração vem desativada por padrão, então uma revisão concluída passa mesmo quando relata problemas. Ative-a em Publicar resultados; consulte Publicação dos resultados.
Contam como problemas tudo o que a revisão encontrou dentro do escopo do feedback, inclusive o que a discussão já tinha levantado, e as conversas anteriores do HeyDeer que continuam abertas. Preocupações recusadas por alguém com acesso de escrita não contam. Consulte Revisões de acompanhamento.
Exigir a verificação antes do merge
- Deixe o HeyDeer revisar pelo menos um pull request no repositório, para que a verificação exista.
- No GitHub, abra a regra de proteção de branch ou o ruleset da sua branch de destino e ative as verificações de status obrigatórias.
- Adicione HeyDeer Review e selecione HeyDeer como origem.
- Ative Reprovar a verificação quando forem encontrados problemas. Caso contrário, a verificação passa mesmo quando uma revisão relata problemas.
O GitHub trata Sucesso, Neutra e Ignorada como aprovadas, e Falha, Ação necessária, Tempo esgotado e Cancelada como bloqueantes. Depois que o HeyDeer passa a publicar verificações em um repositório, toda atualização de pull request recebe um resultado de verificação, então uma verificação obrigatória nunca fica esperando para sempre. Em uma merge queue, a verificação confirma que cada pull request na fila atende aos requisitos de revisão, sem revisar o código combinado nem usar créditos; seu CI ainda deve verificar o merge group.
Em um repositório com Somente manual, o HeyDeer não publica nenhuma verificação até fazer a primeira revisão nele. Consulte Revisões automáticas.
Solicitar uma revisão pela verificação
Re-run, Re-run all e o botão Review this revision funcionam como comentar @heydeer review em nome de quem clicou, para o commit daquela verificação. Review this revision aparece quando uma revisão é o próximo passo. Consulte Comandos em comentários do PR.