Skip to main content

Acerca de los tipos de configuración para el examen de código

Según sus necesidades, GitHub ofrece una configuración predeterminada o avanzada para el análisis de código.

Acerca de la configuración predeterminada

La configuración predeterminada para el code scanning es la manera más rápida, sencilla y con menos mantenimiento para habilitar el code scanning para un repositorio. En función del código del repositorio, la configuración predeterminada creará automáticamente una configuración personalizada del code scanning. Después de habilitar la configuración predeterminada, se analizará el código escrito en lenguajes compatibles con CodeQL en el repositorio:

  • En cada envío de cambios a la rama predeterminada del repositorio o cualquier rama protegida. Para más información sobre las ramas protegidas, consulta Acerca de las ramas protegidas.
  • Al crear o confirmar una solicitud de incorporación de cambios basada en la rama por defecto del repositorio, o cualquier rama protegida, excluidas las solicitudes de incorporación de cambios desde bifurcaciones.
  • Según una programación semanal.

Si necesitas un control más pormenorizado de la configuración del code scanning, debes establecer una configuración avanzada.

Idiomas compatibles

Se recomienda habilitar la configuración predeterminada para repositorios aptos si hay alguna posibilidad de que los repositorios incluyan al menos un lenguaje compatible con CodeQL en el futuro. Si habilitas la configuración predeterminada en un repositorio que no incluya ningún lenguaje compatible con CodeQL, la configuración predeterminada no ejecutará ningún análisis ni usará ningún minuto de GitHub Actions. Si los idiomas compatibles con CodeQL se agregan a la reama predeterminada del repositorio, la configuración predeterminada comenzará automáticamente a analizar los idiomas compatibles con CodeQL y a usar minutos de GitHub Actions. Para más Información sobre los lenguajes compatibles con CodeQL, consulta Acerca del examen de código con CodeQL.

Si el código de un repositorio cambia para incluir cualquier idioma admitido por CodeQL, GitHub actualizará automáticamente la configuración de code scanning para incluir los nuevos idiomas. Si el code scanning da error con la nueva configuración, GitHub reanuda automáticamente la configuración anterior para que el repositorio no pierda la cobertura de code scanning.

Ejecutores disponibles

Puede usar la configuración predeterminada para todos los lenguajes compatibles con CodeQL en ejecutores autohospedados o ejecutores hospedados por GitHub.

Puede asignar ejecutores autohospedados para la configuración predeterminada proporcionando a los ejecutores la etiqueta predeterminada code-scanning, o puede asignarles etiquetas personalizadas para que los repositorios individuales puedan usar diferentes ejecutores.

Salvo que se trate de un caso de uso específico, se recomienda asignar a los ejecutores solo la etiqueta predeterminada code-scanning. Sin embargo, es posible que quiera usar etiquetas personalizadas para:

  • Asigne los ejecutores autohospedados más eficaces a los repositorios críticos para un análisis de code scanning más rápido.
  • Ejecute los análisis de code scanning en una plataforma determinada (por ejemplo, macOS).
  • Tenga un control detallado de la carga de trabajo de los ejecutores autohospedados y los ejecutores hospedados por GitHub.

Acerca de la configuración avanzada

La configuración avanzada del code scanning es útil cuando necesitas personalizar el code scanning. Mediante la creación y edición de un archivo de flujo de trabajo, puede definir cómo desarrollar lenguajes compilados, elegir las consultas que deben ejecutarse, seleccionar los lenguajes que deben examinarse, usar una compilación de matriz, etc. También tiene acceso a todas las opciones para controlar los flujos de trabajo, por ejemplo: cambiar la programación de examen, definir desencadenadores de flujos de trabajo, especificar los ejecutores especialistas que se van a usar.

Su administrador del sitio también puede hacer que acciones de terceros estén disponibles para el code scanning para los usuarios si configura GitHub Connect. Para más información, consulta Configuración la digitalización de código para el dispositivo.

Si ejecutas el análisis de código mediante varias configuraciones, en ocasiones una alerta tendrá varios orígenes de análisis. Si una alerta tiene varios orígenes de análisis, puede ver el estado de la alerta para cada origen de análisis en la página de alertas. Para más información, consulta Acerca de las alertas de análisis de código.

Pasos siguientes

Puede habilitar la configuración predeterminada para un único repositorio, varios repositorios o todos los repositorios de una organización al mismo tiempo.

Para configurar la configuración avanzada en su lugar, consulte Establecimiento de la configuración avanzada para el examen del código.