Nota:
GitHub Code Quality está actualmente en versión preliminar pública y sujeto a cambios. Durante versión preliminar pública, Code Quality no se facturará, aunque los escaneos de Code Quality consumirán minutos de GitHub Actions.
Introducción
Puede bloquear las solicitudes de incorporación de cambios que no cumplan los estándares de calidad del código agregando la regla de rama Requerir resultados de calidad de código a un conjunto de reglas y especificando el nivel de gravedad que necesita. Si una solicitud de incorporación de cambios no alcanza este umbral, no se puede fusionar.
Prerrequisitos
- Code Quality está habilitado. Consulta Habilitación de GitHub Code Quality
- Código en un idioma compatible. Consulte Idiomas admitidos.
Nota:
El umbral solo tendrá un impacto si el repositorio tiene código en uno o varios de los idiomas admitidos, consulte Habilitación de GitHub Code Quality.
Confirmar que Code Quality se ejecuta correctamente en pull requests
Antes de agregar o actualizar un conjunto de reglas para incluir un umbral para Code Quality, confirme que el flujo de trabajo Calidad del código se está ejecutando e informa de los resultados a las solicitudes de incorporación de cambios. De lo contrario, el conjunto de reglas podría bloquear la combinación de todas las solicitudes de incorporación de cambios.
- Abra una solicitud de incorporación de cambios reciente y desplácese hasta el resumen "Comprobaciones" en la parte inferior de la solicitud de incorporación de cambios.
- Confirme que la comprobación "CodeQL: calidad del código" se ejecutó correctamente y notificó su estado.
Para más información, consulta Análisis con tecnología CodeQL para la calidad del código.
Adición o actualización de un conjunto de reglas para incluir Code Quality
- Vaya a la pestaña "Configuración" del repositorio.
- En la barra lateral izquierda, en "Código y automatización", expanda Reglas y haga clic en Conjuntos de reglas.
- Si aún no tiene un conjunto de reglas para proteger la rama predeterminada, expanda Nuevo conjunto de reglas y haga clic en Nuevo conjunto de reglas de rama. Como alternativa, abra el conjunto de reglas existente para la rama predeterminada y vaya al paso 5.
- Si va a crear un nuevo conjunto de reglas:
- Defina un nombre para el conjunto de reglas.
- Establezca "Estado de cumplimiento" en "Activo".
- En "Ramas de destino", agregue un destino de "Incluir rama predeterminada".
- En "Reglas de rama", habilite "Requerir resultados de calidad de código".
- Establezca "Gravedad" para definir el nivel más bajo de gravedad de los resultados de calidad del código que se deben resolver antes de que un pull request pueda fusionarse en la rama predeterminada. Por ejemplo:
- Establezca "Errores" para bloquear las solicitudes de incorporación de cambios con errores de calidad de código no resueltos que se están fusionando.
- Establezca "Advertencias y superior" para bloquear las solicitudes de incorporación de cambios con advertencias o errores de calidad de código sin resolver que se están fusionando.
- Establezca "Notas y superior" para bloquear las solicitudes de incorporación de cambios con notas, advertencias o errores de calidad de código sin resolver que se están fusionando.
- Establezca "Todo" para bloquear las solicitudes de incorporación de cambios con cualquier resultado de calidad de código sin resolver que se estén fusionando.
- Cuando haya terminado de definir o editar el conjunto de reglas, haga clic en Crear o Guardar cambios.
Pasos siguientes
Obtenga información sobre cómo GitHub Code Quality funciona en las solicitudes de incorporación de cambios para evitar que los problemas de calidad del código lleguen a la rama predeterminada. Consulta Corrección de los resultados de calidad de código antes de combinar el pull request.