La comprobación HeyDeer Review
HeyDeer informa de cada revisión en una comprobación de GitHub llamada HeyDeer Review. Descubre qué significa su resultado y cómo hacer que bloquee la fusión.
Qué muestra la comprobación
La comprobación aparece en el commit que revisó HeyDeer. Muestra el progreso de la revisión y luego finaliza con una de las conclusiones que se indican más abajo. Su enlace Details abre la revisión en HeyDeer.
Mientras Autopilot trabaja en un PR, la comprobación sigue en curso hasta que Autopilot se detiene y HeyDeer publica su revisión.
De forma predeterminada, los hallazgos no hacen fallar la comprobación. Para bloquear la fusión hasta que se corrijan o se descarten, activa Marcar la comprobación como fallida si se detectan problemas y exige la comprobación.
El resumen empieza con el número de hallazgos, problemas anteriores abiertos y comprobaciones del repositorio fallidas. En una revisión de seguimiento, indica si HeyDeer revisó solo los cambios desde su revisión anterior.
Debajo, la comprobación muestra la revisión completa: notas de la revisión, todos los hallazgos, los problemas descartados 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.
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 base y activa las comprobaciones de estado obligatorias.
- Añade HeyDeer Review y selecciona HeyDeer como su origen.
- En HeyDeer, activa Marcar la comprobación como fallida si se detectan problemas en Configuración del espacio de trabajo → Reglas de revisión → Publicar resultados o en las Reglas de revisión de un repositorio.
GitHub considera que Success, Neutral y Skipped pasan, y que Failure, Action required, Timed out y Cancelled 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 un repositorio con Solo manual, HeyDeer no publica ninguna comprobación hasta su primera revisión en él. Consulta Revisiones automáticas.
Si no aparece ninguna comprobación, consulta Solución de problemas.
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 hallazgos.
Con la opción activada, la comprobación falla si hay hallazgos dentro del alcance de los comentarios, incluidos los vinculados a conversaciones existentes, o problemas anteriores abiertos o sin confirmar. Los problemas que alguien con acceso de escritura descartó no cuentan. Consulta Problemas anteriores.
Una revisión con notas de la revisión también falla. Algunos commits que no se revisaron automáticamente muestran Action required en lugar de Skipped; consulta Conclusiones.
Conclusiones
| Conclusión | Título | Cuándo |
|---|---|---|
| Success | Revisión completada: no se encontraron problemas / Revisión completada con hallazgos / Hay problemas anteriores por confirmar / Revisión completada con advertencias | La revisión está completa y no hay nada que aclarar. Con Marcar la comprobación como fallida si se detectan problemas desactivado, esto incluye las revisiones con hallazgos o problemas anteriores. |
| Neutral | Revisión incompleta / Revisión completada con hallazgos / La revisión requiere aclaración | Una pregunta requiere aclaración, sea cual sea la opción, o la revisión tiene notas de la revisión y Marcar la comprobación como fallida si se detectan problemas está desactivado. |
| Failure | La revisión encontró problemas que atender / Hay problemas anteriores por confirmar / Revisión incompleta / No se pudo ejecutar la revisión / La revisión falló | Con Marcar la comprobación como fallida si se detectan problemas activado: hallazgos, problemas anteriores o notas de la revisión. Sea cual sea la opción: no se ejecutó una comprobación del repositorio, no se volvió a comprobar un problema anterior, o HeyDeer no pudo iniciar o terminar la revisión. |
| Timed out | La revisión superó el tiempo límite | La revisión se quedó sin tiempo. |
| Cancelled | Revisión cancelada / Revisión reemplazada | La revisión se canceló, o su resultado ya no se aplica porque cambió la rama base o ningún PR abierto tiene este commit como su último commit. |
| Skipped | Revisión omitida / No hay archivos para revisar | Tus filtros de revisión automática excluyen el pull request (de forma predeterminada, los borradores, los PR de forks y las actualizaciones de dependencias), o todos los archivos modificados quedan fuera del alcance de la revisión. La comprobación también se omite cuando HeyDeer detiene una revisión automática porque el PR cambió. |
| Skipped o Action required | Revisión omitida / Revisión necesaria | No se ejecutó ninguna revisión automática por Solo manual, Una vez por PR, una pausa en el PR o Máximo de revisiones automáticas por PR. También puede deberse a que el espacio de trabajo se quedó sin créditos o alcanzó su límite de uso, o a que el repositorio está vinculado a créditos gratuitos en otro espacio de trabajo. Con Marcar la comprobación como fallida si se detectan problemas activado, el resultado es Action required, que bloquea la fusión. |
Cuando HeyDeer no revisa un commit automáticamente, el título indica el motivo, por ejemplo, que el pull request alcanzó el Máximo de revisiones automáticas por PR.
Cuando un commit no se revisó o la revisión no terminó, el resumen indica qué hacer a continuación, normalmente comentar @heydeer review. Consulta también Solución de problemas.
Solicitar una revisión desde la comprobación
Re-run, Re-run all y el botón Revisar esta versión solicitan una revisión del commit de la comprobación, como si comentaras @heydeer review. Revisar esta versión aparece cuando el siguiente paso es una revisión. Consulta Comandos en comentarios de PR.
Si HeyDeer no puede aceptar la solicitud, la comprobación se queda como está. Comenta @heydeer review para ver el motivo.
Colas de fusión
En una cola de fusión, 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 fusión.
Cuando varios PR abiertos comparten un commit
Los PR abiertos con el mismo último commit comparten una comprobación, que solo pasa cuando la revisión de cada PR permite la fusión. Su resumen enlaza al informe completo de cada PR.
Una comprobación compartida no tiene el botón Revisar esta versión; solicita la revisión en el PR correspondiente.