Descripción general
En vez de proporcionar estados de creación de pase/fallo, las GitHub Apps pueden reportar estados enriquecidos, anotar información detallada en las líneas de código y re-ejecutar las pruebas. La funcionalidad de la API de Verificaciones se encuentra disponible exclusivamente para tus GitHub Apps.
Para obtener un ejemplo de cómo utilizar la API de Verificaciones con una App GitHub, consulta la sección "Crear pruebas de IC con la API de verificaciones".
Acerca de las suites de verificaciones
Cuando alguien carga código a un repositorio, GitHub crea una suite de verificación para la última confirmación. Una suite de verificación es un conjunto de ejecuciones de verificación que crea una sola GitHub App para una confirmación específica. Las suites de Verificación resumen el estado y la conclusión de la ejecución de verificación que incluye dicha suite.
La suite de verificación reporta la conclusion de la ejecución de verificación con la prioridad más alta en conclusion de la suite de verificación. Por ejemplo, si tres ejecuciones de verificación tienen conclusiones de timed_out, success, y neutral, la conclusión de la suite de verificación será timed_out.
Predeterminadamente, GitHub crea una suite de verificación automáticamente cuando se carga el código al repositorio. Este flujo predeterminado evía el evento check_suite (con la acción requested) a todas las GitHub Apps que tengan el permiso de checks:write. Cuando tu GitHub App recibe el evento check_suite, esta púede crear ejecuciones de verificación nuevas para la última confirmación. GitHub agrega las ejecuciones de verificación nuevas a la suite de verificación correcta con base en el repositorio y SHA de dicha ejecución de verificación.
Si no quieres utilizar el flujo automático predeterminado, puedes controlar cuando creas las suites de verificación. Para cambiar la configuración predeterminada para la creación de suites de verificación, utiliza la terminal Actualizar las preferencias del repositorio para las suites de verificación. Todos los cambios que se realicen en la configuración del flujo automático se registran en la bitácora de auditoría del repositorio. Si inhabilitaste el flujo automático, puedes crear una suite de verificación utilizando la terminal Crear una suite de verificación. Debes seguir utilizando la terminal Crear una ejecución de verificación para proporcionar retroalimentación sobre una confirmación.
El permiso de escritura para la API de Verificaciones solo está disponible para las Github Apps. Las Apps de OAuth y los usuarios autenticados pueden ver las ejecuciones de verificación y las suites de verificación, pero no pueden crearlas. Si no estás creando una GitHub App, puede que te interese la API de estados.
Para utilizar la API de suites de verificación, la GitHub App debe tener el permiso de checks:write y también suscribirse al webhook de check_suite.
Para obtener información sobre cómo autenticarte como una GitHub App, consulta la sección "Opciones de Autenticación para GitHub Apps".
Acerca de las ejecuciones de verificación
Una ejecución de verificación es una prueba individual que forma parte de una suite de verificación. Cada ejecución incluye un estado y una conclusión.
Puedes crear la ejecución de verificación tan pronto como recibas el webhook de check_suite, aún si ésta todavía no se completa. Puedes actualizar el status de la ejecución de verificación ya que se completa con los valores queued, in_progress, o completed, y puedes actualizar la output conforme vayan estando disponibles los detalles adicionales. Una ejecución de verificación puede contener estampas de tiempo, un enlace para encontrar más detalles en tu sitio externo, anotaciones detalladas para líneas de código específcas, e información acerca del análisis que se llevó a cabo.
Una verificación también puede volverse a ejecutar en la IU de GitHub. Consulta la sección "Acerca de las verificaciones de estado" para obtener más detalles. Cuando esto ocurre, la GitHub App que creó la ejecución de verificación recibirá el webhook check_run que solicita una ejecución de verificación nueva. Si creas una ejecución de verificación sin crear una suite de verificación, GitHub la creará para tí automáticamente.
El permiso de escritura para la API de Verificaciones solo está disponible para las Github Apps. Las Apps de OAuth y los usuarios autenticados pueden ver las ejecuciones de verificación y las suites de verificación, pero no pueden crearlas. Si no estás creando una GitHub App, puede que te interese la API de estados.
Para utilizar la API de Ejecuciones de Verificación, la GitHub App debe tener el permiso de checks:write y también debe poder suscribirse al webhook de check_run.
Ejecuciones de verificación y acciones solicitadas
Cuando configuras una ejecución de verificación con las acciones solicitadas (no se debe confundir esto con GitHub Actions), puedes mostrar un botón en la vista de la solicitud de extracción en GitHub que permita a las personas solicitar tu App GitHub para llevar a cabo tareas adicionales.
Por ejemplo, una app de limpieza de código puede utilizar las acciones solicitadas para mostrar un botón en una solicitud de extracción para arreglar automáticamente los errores de sintaxis detectados.
Para crear un botón que pueda solicitarle a tu app acciones adicionales, utiliza el objetoactions cuando Creas una ejecución de verificación. Por ejemplo, el objeto actions que se muestra a continuación muestra un botón en una solicitud de extracción con la etiqueta "Fix This". El botón aparece después de que se completa la ejecución de verificación.
"actions": [{
"label": "Fix this",
"description": "Let us fix that for you",
"identifier": "fix_errors"
}]
Cuando un usuario da clic en el botón, GitHub envía el webhook de check_run.requested_action a tu app. Cuando tu app recibe el evento de webhook de check_run.requested_action, este puede buscar la clave de requested_action.identifier en la carga útil del webhook para determinar qué botón se pulsó y llevar a cabo la tarea solicitada.
Para obtener un ejemplo detallado de cómo configurar las acciones solicitadas con la API de Verificaciones, consulta la sección "Crear pruebas de IC con la API de verificaciones".