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, el código escrito en los lenguajes compatibles con CodeQL en su repositorio se analizará usando CodeQL:
- 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.
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.
Personalización de la configuración predeterminada
Después de ejecutar un análisis inicial del código con la configuración predeterminada, puede realizar cambios en la configuración para satisfacer mejor sus necesidades.
Opciones de configuración
Para las configuraciones existentes de la configuración predeterminada, puedes editar:
- Qué lenguajes se analizarán con la configuración predeterminada.
- El conjunto de consultas que se ejecuta durante el análisis. Para obtener más información sobre los conjuntos de consultas disponibles, consulta Conjuntos de consultas codeQL.
- Modelos de riesgos (beta) que se van a usar para el análisis. La elección del modelo de riesgos determina qué orígenes de datos contaminados se tratan como un riesgo para la aplicación. Durante la beta, los modelos de amenazas son compatibles únicamente para el análisis de Java/Kotlin y C#. Para obtener más información sobre los modelos de riesgos, consulta Incluir orígenes locales de datos contaminados en la configuración predeterminada.
Si el código base depende de una biblioteca o marco que no reconozcan las bibliotecas estándar incluidas con CodeQL, también puede ampliar la cobertura de CodeQL en la configuración predeterminada al usar paquetes de modelos CodeQL. Para obtener más información, consulta Extender la cobertura de CodeQL con paquetes de modelos codeQL en la configuración predeterminada.
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 code-scanning.
Acerca de la configuración avanzada
Si necesitas un control más pormenorizado de la configuración del code scanning, debes establecer una configuración avanzada. La configuración avanzada del code scanning es útil cuando necesitas personalizar el code scanning. Puede configurar code scanning con GitHub Actions o un sistema de integración o implementación/entrega continuas (CI/CD).
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.
Con GitHub Actions
Al crear y editar un archivo de flujo de trabajo GitHub Actions , puede definir cómo crear lenguajes compilados, elegir qué consultas ejecutar, seleccionar los idiomas que se van a examinar, usar una compilación de matriz y mucho más. 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 poner acciones de terceros a disposición de los usuarios para code scanning, configurando GitHub Connect. Para más información, consulta Configuración la digitalización de código para el dispositivo.
Con un sistema de CI/CD de terceros
Como alternativa a ejecutar code scanning dentro de GitHub usando GitHub Actions, puede analizar el código en un sistema externo de CI/CD y luego subir los resultados a GitHub.
La CodeQL CLI es una herramienta de línea de comandos independiente que puedes utilizar para analizar código. Puedes añadir la CodeQL CLI a tu sistema de terceros, o utilizar otra herramienta de análisis estático de terceros que pueda producir resultados como datos del Formato de Intercambio de Resultados para Análisis Estático (SARIF) 2.1.0. Para más información, consulta Acerca de la CLI de CodeQL y Soporte de SARIF para escaneo de código.
Las alertas para code scanning que genere externamente se muestran de la misma forma que aquellas para el code scanning que genere con GitHub.
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 obtener un único repositorio, consulte Establecimiento de la configuración predeterminada para el examen del código.
- Para la habilitación masiva, consulte Establecimiento de la configuración predeterminada para el examen de código a gran escala.
Para configurar la configuración avanzada en su lugar, consulte Establecimiento de la configuración avanzada para el examen del código.