Set code scanning merge protection

Secure your codebase by blocking pull requests that fail code scanning checks.

¿Quién puede utilizar esta característica?

Propietarios de la organización, administradores de seguridad y miembros de la organización con el rol de administrador

Code scanning está disponible para los tipos de repositorio siguientes:

  • Repositorios públicos en GitHub.com
  • Repositorios propiedad de la organización en GitHub Team, GitHub Enterprise Cloud, o GitHub Enterprise Server, con GitHub Code Security habilitados.

En este artículo

Creating a merge protection ruleset for a repository

  1. En GitHub, navegue hasta la página principal del repositorio.

  2. Debajo del nombre del repositorio, haz clic en Settings. Si no puedes ver la pestaña "Configuración", selecciona el menú desplegable y, a continuación, haz clic en Configuración.

    Captura de pantalla de un encabezado de repositorio en el que se muestran las pestañas. La pestaña "Configuración" está resaltada con un contorno naranja oscuro.

  3. En la barra lateral izquierda, en "Código y automatización", haz clic en Reglas y, a continuación, haz clic en Conjuntos de reglas.

    Captura de pantalla de la barra lateral de la página "Configuración" de un repositorio. El submenú "Reglas" se expande y la opción "Conjuntos de reglas" tiene un contorno naranja.

  4. Click New ruleset.

  5. To create a ruleset targeting branches, click New branch ruleset.

  6. En «Nombre del conjunto de reglas», escribe un nombre para el conjunto de reglas.

  7. Opcionalmente, para cambiar el estado de cumplimiento predeterminado, haz clic en Disabled y selecciona un estado de cumplimiento.

  8. En "Protecciones de rama", seleccione Requerir resultados de code scanning.

  9. En "Required tools and alert thresholds", haz clic en Add tool y selecciona una herramienta de code scanning con el menú desplegable. Por ejemplo, "CodeQL".

  10. Junto al nombre de una herramienta code scanning:

    • Haga clic en Alertas y seleccione una de las opciones: Ninguno, Errores, Errores y advertencias o Todos.
    • Haga clic en Alertas de seguridad y seleccione una de las opciones: Ninguno, Crítico, Alto o superior, Medio o superior o Todos.

    Captura de pantalla de la sección "Herramientas necesarias y umbrales de alerta" de la configuración "Conjuntos de reglas".

Para más información sobre la gravedad de las alertas y los niveles de gravedad de la seguridad, consulta Acerca de las alertas de análisis de código.

For more information about managing rulesets in a repository, see Administración de conjuntos de reglas de un repositorio.

Creating a merge protection ruleset with the REST API

You can use the REST API to create a ruleset with the code_scanning rule, which allows you to define specific tools and set alert thresholds. For more information, see Puntos de conexión de la API de REST para reglas.