Las comprobaciones de estado muestran si las confirmaciones cumplen las condiciones establecidas para un repositorio. Normalmente se crean mediante sistemas externos, como compilaciones de integración continua, pruebas, examen de código o comprobaciones de implementación.
Las comprobaciones de estado ayudan a los revisores y mantenedores a comprender si una solicitud de incorporación de cambios está lista para combinarse. Una comprobación puede mostrar que el trabajo sigue en ejecución, que los cambios han pasado la validación o que algo necesita atención.
Cualquier persona con permisos de escritura a un repositorio puede determinar el estado de cualquier comprobación de estado en el repositorio.
Si se requieren comprobaciones de estado para una rama protegida, deben pasarse antes de que se pueda combinar la solicitud de incorporación de cambios. Consulte Acerca de las ramas protegidas.
Nota:
Si se omite un trabajo, se notificará su estado como "Success". No impedirá que una solicitud de incorporación de cambios se combine, incluso si es una comprobación necesaria.
Tipos de comprobaciones de estado activadas GitHub
Hay dos tipos de comprobaciones de estado en GitHub:
| Tipo | Nivel de detalle | Creado por |
|---|---|---|
| Comprobaciones | Salida detallada, anotaciones y mensajes. | |
| GitHub Apps, incluido GitHub Actions. | ||
| Estados de confirmación | Un estado más sencillo para una confirmación. | Servicios externos e integraciones. |
Nota:
GitHub Actions genera comprobaciones, no estados de confirmación, cuando se ejecutan flujos de trabajo.
Los propietarios de la organización y los usuarios con acceso de inserción a un repositorio pueden crear comprobaciones y confirmar estados con GitHubla API de . Consulte Puntos de conexión de la API de REST para comprobaciones y Puntos de conexión de la API de REST para estados de confirmaciones.
Comprobaciones
Las comprobaciones pueden incluir registros de compilación, resultados de pruebas, anotaciones y vínculos a más detalles. En una solicitud de incorporación de cambios, la pestaña Comprobaciones le ayuda a comprender qué validaciones se ejecutaron y por qué se ha superado o fallado una comprobación.
Nota:
La pestaña Comprobaciones se rellena solo para las solicitudes de incorporación de cambios si configura comprobaciones, no estados de confirmación, para el repositorio.
Cuando una comprobación apunta a una línea específica, los detalles también pueden aparecer en la pestaña Archivos de la solicitud de incorporación de cambios. Esto ayuda a los revisores a conectar comentarios automatizados al código que se va a cambiar.
Omitir y solicitar verificaciones para confirmaciones individuales
Algunos repositorios permiten omitir o solicitar comprobaciones para confirmaciones individuales. Esto puede ser útil cuando una comprobación no es relevante para un cambio específico o cuando las comprobaciones no se solicitan automáticamente.
En GitHub Actions el caso de los flujos de trabajo, puede omitir las ejecuciones de flujo de trabajo desencadenadas por los eventos y pull_request mediante una instrucción skip en el push mensaje de confirmación. Consulte Saltarse las ejecuciones de código.
De forma alternativa, para omitir o solicitar todas las verificaciones para tu confirmación, agrega una de las siguientes lineas de introducción al final de tu mensaje de confirmación:
-
A fin de omitir comprobaciones para una confirmación, escriba su mensaje de confirmación, y una descripción corta y significativa de sus cambios. Después de la descripción del commit, antes de la cita de cierre, añada dos líneas vacías seguidas de
skip-checks: true:$ git commit -m "Update README > > skip-checks: true" -
A fin de solicitar comprobaciones para una confirmación, escriba su mensaje de confirmación, y una descripción corta y significativa de sus cambios. Después de la descripción del commit, antes de la cita de cierre, añada dos líneas vacías seguidas de
request-checks: true:$ git commit -m "Refactor usability tests > > request-checks: true"
De forma predeterminada, Git quita automáticamente las nuevas líneas consecutivas. Para dejar el mensaje de confirmación exactamente como lo escribiste, usa la opción --cleanup=verbatim en la confirmación. Para más información, vea --cleanup=<mode> en la documentación de Git.
Comprobación de estados y conclusiones
Comprueba cómo se mueven los estados a medida que se ejecutan y, a continuación, reciben una conclusión cuando finalizan. Algunos estados no se pueden establecer manualmente y están reservados para GitHub Actions.
| Situación | Description |
GitHub Actions ¿solamente? |
| --- | --- | --- |
| completed | La verificación se ha completado y tiene una conclusión (consulta a continuación). | No |
| expected | La ejecución de comprobación espera a que se notifique un estado. | Sí |
| failure | Se ha producido un error en la ejecución de comprobación. | No |
| in_progress | La ejecución de comprobación está en curso. | No |
| pending | La ejecución de comprobación está en la parte delantera de la cola, pero se ha alcanzado el límite de simultaneidad basada en grupos. | Sí |
| queued | La ejecución de comprobación se ha puesto en cola. | No |
| requested | Se ha creado la ejecución de comprobación, pero no se ha puesto en cola. | Sí |
| startup_failure | Se ha producido un error al iniciar el conjunto de comprobaciones. Este estado no es aplicable a las ejecuciones de comprobación. | Sí |
| waiting | La ejecución de comprobación espera a que se cumpla una regla de protección de implementación. | Sí |
Cuando una comprobación tiene un estado de completed, tiene una conclusión. Una conclusión correcta normalmente significa que la comprobación no bloquea la combinación. Un error, tiempo de espera o conclusión necesaria para la acción normalmente significa que alguien debe revisar los detalles antes de que la solicitud de incorporación de cambios pueda combinarse.
| Conclusion | Description |
|---|---|
action_required | La ejecución de comprobación ha proporcionado acciones requeridas una vez completada. Para obtener más información, vea Uso de la API REST para interactuar con comprobaciones. |
cancelled | La ejecución del proceso de verificación fue cancelada antes de que se completara. |
failure | Se ha producido un error en la ejecución de comprobación. |
neutral | La ejecución de comprobación se ha completado con un resultado neutro. Esto se trata como un éxito para las comprobaciones dependientes en GitHub Actions. |
skipped | Se ha omitido la ejecución de comprobación. Esto se trata como un éxito para las comprobaciones dependientes en GitHub Actions. |
stale | La ejecución de comprobación se marcó obsoleta porque GitHub tardó demasiado tiempo. |
success | La ejecución de comprobación se ha completado correctamente. |
timed_out | Se agotó el tiempo de ejecución de la comprobación. |
Retención de cheques
GitHub conserva los datos de comprobaciones durante 400 días. Después de 400 días, los datos se archivan. 10 días después del archivado, los datos se eliminan permanentemente.
Para combinar una solicitud de incorporación de cambios con comprobaciones necesarias y archivadas, debe volver a ejecutar las comprobaciones.