Compartir vía

AdvancedSecurity-Codeql-Init@1: tarea Advanced Security Initialize CodeQL v1

  • Artículo

Inicializa la base de datos CodeQL como preparación para la compilación.

Debe tener GitHub Advanced Security para Azure DevOps habilitado para el repositorio que se está examinando.

Syntax

# Advanced Security Initialize CodeQL v1
# Initializes the CodeQL database in preparation for building.
- task: AdvancedSecurity-Codeql-Init@1
  inputs:
    #languages: # 'csharp' | 'cpp' | 'go' | 'java' | 'javascript' | 'python' | 'ruby' | 'swift'. Languages to analyze. 
    #querysuite: 'Select a query suite...' # 'Select a query suite...' | 'code-scanning' | 'security-extended' | 'security-experimental' | 'security-and-quality'. CodeQL Query Suite to use for analysis. Default: Select a query suite....
  # Advanced
    #ram: # string. Options to control RAM usage in MB. 
    #threads: # string. Use this many threads to evaluate queries. 
    #codeqlpathstoignore: # string. Set a list of paths to exclude in the CodeQL analysis. 
    #codeqlpathstoinclude: # string. Set a list of additional paths to include in the CodeQL analysis. 
    #sourcesfolder: # string. Sets the folder that contains the sources to be analyzed. 
    #loglevel: '_' # '0' | '1' | '2' | '_'. Set the log level for the CodeQL analysis. Default: _.
    #configfilepath: # string. Use this to enable custom query analysis in codeql (path must be absolute). 
    #codeqltoolsdirectory: # string. Set a custom CodeQL tools directory (path must be absolute).

Entradas

languages - Idiomas que se van a analizar
string. Valores permitidos: csharp, , gocpp, java, javascript, python, , ruby, . swift

Lenguaje de programación que se va a analizar. Varios idiomas pueden estar separados por una coma.

Puede establecer el idioma aquí en la tarea, o bien puede especificar el idioma en una variable de canalización denominada advancedsecurity.codeql.language. Si se establecen ambos, el valor especificado en la tarea tiene prioridad.


querysuite - Conjunto de consultas codeQL que se va a usar para el análisis.
string. Valores permitidos: Select a query suite..., code-scanning, security-extended, security-experimental, . security-and-quality Valor predeterminado: Select a query suite....

Conjunto de reglas del conjunto de consultas, que se usa para el análisis. Puede especificar el valor aquí en la tarea, o bien puede especificarlo en una variable de canalización denominada advancedsecurity.codeql.querysuite. Si se establecen ambos, el valor especificado en la tarea tiene prioridad. El valor predeterminado es Select a query suite... que indica que el conjunto de consultas debe especificarse en la advancedsecurity.codeql.querysuite variable .


ram - Opciones para controlar el uso de RAM en MB
string.

Establece la cantidad total de RAM que debe permitirse usar al evaluador de consultas.

Puede especificar ram aquí en la tarea o puede especificarlo en una variable de canalización denominada advancedsecurity.codeql.ram. Si se establecen ambos, el valor especificado en la tarea tiene prioridad.


threads - Use estos muchos subprocesos para evaluar las consultas.
string.

Puedes pasar 0 para usar un subproceso por núcleo en la máquina o -N para dejar N núcleos sin utilizar (excepto que aún se usa al menos un subproceso).

Puede especificar threads aquí en la tarea o puede especificarlo en una variable de canalización denominada advancedsecurity.codeql.threads. Si se establecen ambos, el valor especificado en la tarea tiene prioridad.


codeqlpathstoignore - Establecer una lista de rutas de acceso que se excluirán en el análisis de CodeQL
string.

Puede proporcionar varias rutas de acceso separadas por comas. Las rutas de acceso deben ser relativas a dónde sourcesfolder se ejecuta CodeQL, que tiene como valor predeterminado la variable de entorno de canalización Build.SourcesDirectory . Por ejemplo, para pasar por alto el $(Build.SourcesDirectory)/donotscan directorio, establezca codeqlpathstoignore: donotscan en lugar de codeqlpathstoignore: $(Build.SourcesDirectory)/donotscan.


codeqlpathstoinclude - Establecer una lista de rutas de acceso adicionales que se van a incluir en el análisis de CodeQL
string.

Puede proporcionar varias rutas de acceso separadas por comas. Las rutas de acceso deben ser relativas a dónde sourcesfolder se ejecuta CodeQL, que tiene como valor predeterminado la variable de entorno de canalización Build.SourcesDirectory . Por ejemplo, para incluir el $(Build.SourcesDirectory)/app directorio , establezca codeqlpathstoinclude: app en lugar de codeqlpathstoinclude: $(Build.SourcesDirectory)/app.


sourcesfolder - Establece la carpeta que contiene los orígenes que se van a analizar.
string.

Si no proporciona este valor, se usa la carpeta de orígenes predeterminada para la infraestructura de canalización (proporcionada por la Build.SourcesDirectory variable ).


loglevel - Establecer el nivel de registro para el análisis de CodeQL
string. Valores permitidos: 0 (Warning), 1 (Verbose), 2 (Debug), _ (Default (Warning)). Valor predeterminado: _.

Especifique el nivel de registro.

Puede especificar loglevel aquí en la tarea o puede especificarlo en una variable de canalización denominada advancedsecurity.codeql.loglevel. Si se establecen ambos, el valor especificado en la tarea tiene prioridad, a menos que se especifique el valor _ predeterminado de loglevel en la tarea. Si _ se especifica , el valor de advancedsecurity.codeql.loglevel se usa si está disponible.


configfilepath - Úselo para habilitar el análisis de consultas personalizado en codeql (la ruta de acceso debe ser absoluta).
string.

Si no se proporciona la ruta de acceso, el análisis de codeql continuará con las consultas predeterminadas.


codeqltoolsdirectory - Establecer un directorio de herramientas codeQL personalizado (la ruta de acceso debe ser absoluta)
string.

Si no se proporciona la ruta de acceso, se usará el valor predeterminado de $agent_toolsdirectory .


Opciones de control de tareas

Todas las tareas tienen opciones de control además de las entradas de tareas. Para obtener más información, vea Opciones de control y propiedades de tareas comunes.

Variables de salida

Ninguno.

Comentarios

Debe tener GitHub Advanced Security para Azure DevOps habilitado para el repositorio que se está examinando.

Importante

Esta tarea solo se admite con Azure Repos repositorios de Git.

La canalización debe llamar a las tareas en el orden siguiente.

  1. Inicializar CodeQL
  2. AutoBuild (o las tareas de compilación personalizadas)
  3. Realización de análisis de CodeQL

La tarea AutoBuild es opcional y puede reemplazarse por las tareas de compilación personalizadas. Se deben ejecutar AutoBuild o las tareas de compilación personalizadas para que el proyecto se analice.

Requisitos

Requisito Descripción
Tipos de canalización YAML, compilación clásica, versión clásica
Se ejecuta en Agente, DeploymentGroup
Peticiones None
Capabilities Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
Restricciones de comandos Any
Variables que se pueden establecer Any
Versión del agente Todas las versiones de agente compatibles.
Categoría de la tarea: Build

Consulte también