A verificação HeyDeer Review
O HeyDeer informa cada revisão em uma verificação do GitHub chamada HeyDeer Review. Saiba o que o resultado dela significa e como fazer com que ela bloqueie o merge.
O que a verificação mostra
A verificação fica no commit que o HeyDeer revisou. Ela mostra o progresso da revisão e depois termina com uma das conclusões abaixo. O link Details dela abre a revisão no HeyDeer.
Enquanto o Autopilot trabalha em um PR, a verificação fica em andamento até o Autopilot parar e o HeyDeer publicar a revisão.
Por padrão, os problemas encontrados não reprovam a verificação. Para bloquear o merge até que eles sejam corrigidos ou recusados, ative Reprovar a verificação quando forem encontrados problemas e torne a verificação obrigatória.
O resumo começa com o número de problemas encontrados, de preocupações anteriores em aberto e de verificações do repositório com falha. Em uma revisão de acompanhamento, ele informa se o HeyDeer revisou apenas as alterações feitas desde a revisão anterior.
Abaixo dele, a verificação mostra a revisão completa: as observações da revisão, todos os problemas encontrados, as preocupações recusadas na discussão e a decisão de aprovação quando a Aprovação automática está ativada. Consulte Como ler uma revisão.
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 base e ative as verificações de status obrigatórias.
- Adicione HeyDeer Review e selecione HeyDeer como a origem.
- No HeyDeer, ative Reprovar a verificação quando forem encontrados problemas em Configurações do espaço de trabalho → Regras de revisão → Publicar resultados ou nas Regras de revisão de um repositório.
O GitHub considera Success, Neutral e Skipped como conclusões que passam, e Failure, Action required, Timed out e Cancelled como conclusões que bloqueiam o merge.
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 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.
Se nenhuma verificação aparecer, consulte Solução de problemas.
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 encontrados.
Com ela ativada, a verificação é reprovada por problemas encontrados dentro do escopo do feedback, incluindo os vinculados a conversas existentes, e por preocupações anteriores em aberto ou não confirmadas. Preocupações recusadas por alguém com acesso de escrita não contam. Consulte Preocupações anteriores.
Uma revisão com observações da revisão também é reprovada. Alguns commits que não foram revisados automaticamente mostram Action required em vez de Skipped; consulte Conclusões.
Conclusões
| Conclusão | Título | Quando |
|---|---|---|
| Success | Revisão concluída — nenhum problema encontrado / Revisão concluída com problemas encontrados / Preocupações anteriores precisam de confirmação / Revisão concluída com avisos | A revisão está completa e nada precisa de esclarecimento. Com Reprovar a verificação quando forem encontrados problemas desativado, isso inclui revisões com problemas encontrados ou preocupações anteriores. |
| Neutral | Revisão incompleta / Revisão concluída com problemas encontrados / A revisão precisa de esclarecimento | Uma pergunta precisa de esclarecimento, qualquer que seja a configuração, ou a revisão tem observações e Reprovar a verificação quando forem encontrados problemas está desativado. |
| Failure | A revisão encontrou problemas a resolver / Preocupações anteriores precisam de confirmação / Revisão incompleta / Não foi possível executar a revisão / A revisão falhou | Com Reprovar a verificação quando forem encontrados problemas ativado: problemas encontrados, preocupações anteriores ou observações da revisão. Qualquer que seja a configuração: uma verificação do repositório não foi executada, uma preocupação anterior não foi verificada novamente ou o HeyDeer não conseguiu iniciar ou concluir a revisão. |
| Timed out | A revisão excedeu o tempo limite | A revisão excedeu o tempo limite. |
| Cancelled | Revisão cancelada / Revisão substituída | A revisão foi cancelada, ou o resultado dela não vale mais porque a branch base mudou ou porque nenhum PR aberto tem este commit como o mais recente. |
| Skipped | Revisão ignorada / Nenhum arquivo para revisar | Seus filtros de revisão automática excluem o pull request (por padrão, rascunhos, PRs de forks e atualizações de dependências) ou todos os arquivos alterados estão fora do escopo da revisão. A verificação também é ignorada quando o HeyDeer interrompe uma revisão automática porque o PR mudou. |
| Skipped ou Action required | Revisão ignorada / Revisão necessária | Nenhuma revisão automática foi executada por causa de Somente manual, Uma vez por PR, uma pausa no PR ou Máximo de revisões automáticas por PR. Isso também pode ocorrer se o espaço de trabalho estiver sem créditos ou tiver atingido seu limite de uso, ou se o repositório estiver vinculado a créditos gratuitos em outro espaço de trabalho. Com Reprovar a verificação quando forem encontrados problemas ativado, o resultado é Action required, que bloqueia o merge. |
Quando o HeyDeer não revisa um commit automaticamente, o título informa o motivo, por exemplo, que o pull request atingiu o Máximo de revisões automáticas por PR.
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. Consulte também Solução de problemas.
Solicitar uma revisão pela verificação
Re-run, Re-run all e o botão Revisar esta versão solicitam uma revisão do commit da verificação, como se você tivesse comentado @heydeer review. Revisar esta versão aparece quando uma revisão é o próximo passo. Consulte Comandos em comentários do PR.
Se o HeyDeer não puder aceitar a solicitação, a verificação fica como está. Comente @heydeer review para ver o motivo.
Filas de merge
Em uma fila de merge, a verificação confirma que cada pull request na fila atende aos requisitos de revisão dele, sem revisar o código combinado nem usar créditos. Seu CI ainda deve verificar o grupo de merge.
Quando vários PRs abertos compartilham um commit
PRs abertos com o mesmo commit mais recente compartilham uma única verificação, que só passa quando a revisão de cada PR permite o merge. O resumo dela tem links para o relatório completo de cada PR.
Uma verificação compartilhada não tem o botão Revisar esta versão; solicite uma revisão no PR específico.