Skip to main content

Propiedades del repositorio para code scanning

Puede usar las propiedades del repositorio para ajustar code scanning según sus necesidades.

Prerrequisitos

Para que las propiedades del repositorio descritas aquí tengan efecto, debe haber configurado code scanning. Consulte Acerca de los tipos de configuración para el examen de código.

Las propiedades del repositorio que afectan a code scanning deben crearse manualmente para la organización. Después, puede establecer valores para ellos que se apliquen a toda la organización o permitir que se configuren de forma diferente para cada repositorio. Consulte Administración de propiedades personalizadas para repositorios de la organización.

Propiedades de repositorio compatibles con code scanning

Algunas funciones de code scanning se pueden configurar mediante propiedades del repositorio. Las organizaciones pueden usar propiedades de repositorio para aplicar configuraciones en todos los repositorios y para repositorios individuales. Si code scanning se personaliza mediante propiedades del repositorio, la personalización se aplica a todos los tipos de configuración.

A continuación, se muestra un resumen de las propiedades del repositorio que puede configurar y que afectan a los análisis de code scanning cuando se definen:

NombreTipo
github-codeql-extra-queriesText
github-codeql-disable-overlayVerdadero o falso
github-codeql-file-coverage-on-prsVerdadero o falso

Nota:

Las propiedades del repositorio compatibles dependen de la versión del github/codeql-action que se utiliza en los análisis de code scanning. Para la configuración avanzada de code scanning, verifique que su flujo de trabajo haga referencia a la última versión principal. La configuración predeterminada de Code scanning utiliza automáticamente la versión más reciente.

Personalización del análisis

La github-codeql-extra-queries propiedad permite configurar consultas adicionales que se deben ejecutar. Esto resulta útil para agregar consultas a todos los análisis pertinentes de la organización sin necesidad de modificar flujos de trabajo individuales ni cambiar a una configuración avanzada. Esto acepta los mismos valores que la queries entrada de github/codeql-action. Consulte Opciones de configuración de flujo de trabajo para el examen de código.

Habilitación o deshabilitación de características

Puede deshabilitar el análisis incremental mejorado configurando la propiedad github-codeql-disable-overlay a true. Esto puede ser útil si se produce un error en el análisis incremental mejorado debido a un aumento de los requisitos de hardware.

La información de cobertura de archivos no se calcula para los análisis de las solicitudes de incorporación de cambios. Si desea habilitar la información de cobertura de archivos para las solicitudes de incorporación de cambios, puede configurar la propiedad github-codeql-file-coverage-on-prs como true.