La comprobación HeyDeer Review
HeyDeer informa de cada revisión como una comprobación de GitHub llamada HeyDeer Review en el commit que revisó. La comprobación incluye el resumen y la revisión completa, y puedes exigirla antes de fusionar.
Qué muestra la comprobación
La comprobación muestra el progreso de la revisión y luego finaliza con una de las conclusiones siguientes. Su enlace Details abre la revisión en HeyDeer.
El resumen empieza con el número de hallazgos, hilos anteriores sin resolver y comprobaciones del repositorio fallidas, e indica si una revisión de seguimiento cubrió solo los cambios desde la revisión anterior de HeyDeer. Después, la página de la comprobación muestra la revisión completa: advertencias, todos los problemas, las observaciones descartadas en la discusión y la decisión de aprobación cuando “Aprobación automática” está activada. Consulta Cómo leer una revisión.
Conclusiones
| Conclusión | Título | Cuándo |
|---|---|---|
| Éxito | Review completed — no issues found / Review completed with findings | Sin problemas, o con problemas si “Marcar la comprobación como fallida si se detectan problemas” está desactivado. |
| Neutral | Review completed with warnings / Review completed with findings | La revisión tiene una advertencia y la opción está desactivada. |
| Fallo | Review found issues that need attention / Review incomplete | Problemas o una advertencia, con la opción activada. Review incomplete también aparece, sea cual sea la opción, cuando no se evaluó una comprobación del repositorio o un hallazgo anterior. |
| Fallo | Review could not run / Review failed | HeyDeer no pudo iniciar o terminar la revisión. El resumen indica el motivo. |
| Tiempo agotado | Review timed out | La revisión se quedó sin tiempo. |
| Cancelada | Review cancelled / Review superseded | La revisión se canceló, o el resultado corresponde a un commit o una rama de destino anteriores. |
| Omitida | Review skipped / No reviewable files | Tus filtros de revisión automática excluyen el pull request (de forma predeterminada, los borradores), o todos los archivos modificados quedan fuera del alcance de la revisión. |
| Omitida o Acción requerida | Review skipped / Review required | El commit no se revisó automáticamente, por ejemplo con “Solo manual”, después de que “Una vez por PR” usara su revisión o al quedarse sin créditos. Es “Acción requerida” cuando la opción está activada. |
Cuando un commit no se revisó o la revisión no terminó, el resumen indica qué hacer a continuación, normalmente comentar @heydeer review.
Marcar la comprobación como fallida si se detectan problemas
Esta opción está desactivada de forma predeterminada, así que una revisión completada pasa aunque informe de problemas. Actívala en Publicar resultados; consulta Publicación de resultados.
Los problemas son los hallazgos dentro del alcance de los comentarios de la revisión, incluidos los que ya se plantearon en la discusión, y los hilos anteriores de HeyDeer que siguen abiertos. Las observaciones que alguien con acceso de escritura descartó no cuentan. Consulta Revisiones de seguimiento.
Exigir la comprobación antes de fusionar
- Deja que HeyDeer revise al menos un pull request del repositorio para que la comprobación exista.
- En GitHub, abre la regla de protección de rama o el ruleset de tu rama de destino y activa las comprobaciones de estado obligatorias.
- Añade HeyDeer Review y selecciona HeyDeer como su origen.
- Activa “Marcar la comprobación como fallida si se detectan problemas”. De lo contrario, la comprobación pasa aunque una revisión informe de problemas.
GitHub considera que “Éxito”, “Neutral” y “Omitida” pasan, y que “Fallo”, “Acción requerida”, “Tiempo agotado” y “Cancelada” bloquean. Una vez que HeyDeer publica comprobaciones en un repositorio, cada actualización de un pull request recibe un resultado de comprobación, así que una comprobación obligatoria nunca se queda esperando indefinidamente. En una cola de merge, la comprobación confirma que cada pull request de la cola cumple sus requisitos de revisión, sin revisar el código combinado ni usar créditos; tu CI debe seguir comprobando el grupo de merge.
En un repositorio con “Solo manual”, HeyDeer no publica ninguna comprobación hasta su primera revisión en él. Consulta Revisiones automáticas.
Solicitar una revisión desde la comprobación
Re-run, Re-run all y el botón Review this revision funcionan igual que comentar @heydeer review como la persona que hizo clic, para el commit de esa comprobación. Review this revision aparece cuando el siguiente paso es una revisión. Consulta Comandos en comentarios de PR.