AdvancedSecurity-Codeql-Init@1 - Tarefa Advanced Security Initialize CodeQL v1
Inicializa a base de dados CodeQL em preparação para a criação.
Tem de ter GitHub Advanced Security para o Azure DevOps ativado para o repositório que está a ser analisado.
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 a analisar
string. Valores permitidos: csharp, , cpp, javago, javascript, python, , . swiftruby
A linguagem de programação a analisar. Vários idiomas podem ser separados por uma vírgula.
Pode definir o idioma aqui na tarefa ou pode especificar o idioma numa variável de pipeline chamada advancedsecurity.codeql.language. Se ambos estiverem definidos, o valor especificado na tarefa tem precedência.
querysuite - CodeQL Query Suite para utilizar para análise.
string. Valores permitidos: Select a query suite..., , code-scanningsecurity-extended, security-experimental, security-and-quality. Valor predefinido: Select a query suite....
O conjunto de consultas, ou seja, o conjunto de regras, utilizado para análise. Pode especificar o valor aqui na tarefa ou pode especificá-lo numa variável de pipeline chamada advancedsecurity.codeql.querysuite. Se ambos estiverem definidos, o valor especificado na tarefa tem precedência. O valor predefinido indica Select a query suite... que o conjunto de consultas tem de ser especificado na advancedsecurity.codeql.querysuite variável .
ram - Opções para controlar a utilização de RAM em MB
string.
Defina a quantidade total de RAM que o avaliador de consultas deve poder utilizar.
Pode especificar ram aqui na tarefa ou pode especificá-la numa variável de pipeline chamada advancedsecurity.codeql.ram. Se ambos estiverem definidos, o valor especificado na tarefa tem precedência.
threads - Utilize estes muitos threads para avaliar consultas
string.
Pode passar 0 para utilizar um thread por núcleo no computador ou -N para deixar N núcleos não utilizados (exceto continuar a utilizar, pelo menos, um thread).
Pode especificar threads aqui na tarefa ou pode especificá-la numa variável de pipeline chamada advancedsecurity.codeql.threads. Se ambos estiverem definidos, o valor especificado na tarefa tem precedência.
codeqlpathstoignore - Definir uma lista de caminhos a excluir na análise do CodeQL
string.
Pode fornecer vários caminhos separados por vírgulas. Os caminhos têm de ser relativos ao local onde o sourcesfolder CodeQL está em execução, o que é predefinido para a variável de ambiente do Build.SourcesDirectory pipeline. Por exemplo, para ignorar o $(Build.SourcesDirectory)/donotscan diretório, defina codeqlpathstoignore: donotscan em vez de codeqlpathstoignore: $(Build.SourcesDirectory)/donotscan.
codeqlpathstoinclude - Defina uma lista de caminhos adicionais a incluir na análise do CodeQL
string.
Pode fornecer vários caminhos separados por vírgulas. Os caminhos têm de ser relativos ao local onde o sourcesfolder CodeQL está em execução, o que é predefinido para a variável de ambiente do Build.SourcesDirectory pipeline. Por exemplo, para incluir o $(Build.SourcesDirectory)/app diretório, defina codeqlpathstoinclude: app em vez de codeqlpathstoinclude: $(Build.SourcesDirectory)/app.
sourcesfolder - Define a pasta que contém as origens a serem analisadas
string.
Se não fornecer este valor, é utilizada a pasta de origens predefinida para a infraestrutura de pipeline (fornecida pela Build.SourcesDirectory variável).
loglevel - Definir o nível de registo para a análise do CodeQL
string. Valores permitidos: 0 (Aviso), 1 (Verboso), 2 (Depuração) _ (Predefinição (Aviso)). Valor predefinido: _.
Especifique o nível de registo.
Pode especificar loglevel aqui na tarefa ou pode especificá-la numa variável de pipeline chamada advancedsecurity.codeql.loglevel. Se ambos estiverem definidos, o valor especificado na tarefa tem precedência, a menos que o valor _ predefinido para loglevel na tarefa seja especificado. Se _ for especificado, o valor de advancedsecurity.codeql.loglevel é utilizado, se disponível.
configfilepath - Utilize esta opção para ativar a análise de consultas personalizada no codeql (o caminho tem de ser absoluto).
string.
Se o caminho não for fornecido, a análise de codeql prosseguirá com as consultas predefinidas.
codeqltoolsdirectory - Definir um diretório de ferramentas codeQL personalizado (o caminho tem de ser absoluto)
string.
Se o caminho não for fornecido, o valor predefinido de $agent_toolsdirectory será utilizado.
Opções de controlo de tarefas
Todas as tarefas têm opções de controlo para além das entradas de tarefas. Para obter mais informações, veja Opções de controlo e propriedades de tarefas comuns.
Variáveis de saída
Nenhum.
Observações
Tem de ter GitHub Advanced Security para o Azure DevOps ativado para o repositório que está a ser analisado.
Importante
Esta tarefa é suportada apenas com repositórios Git de Repositórios do Azure.
O pipeline tem de chamar as tarefas pela seguinte ordem.
- Inicializar CodeQL
- AutoBuild (ou as suas tarefas de compilação personalizadas)
- Efetuar a análise do CodeQL
A tarefa de Construção Automática é opcional e pode ser substituída pelas suas tarefas de compilação personalizadas. A Construção Automática ou as suas tarefas de compilação personalizadas têm de ser executadas para que o seu projeto seja analisado.
Requisitos
| Requisito | Description |
|---|---|
| Tipos de pipeline | YAML, Compilação clássica, Versão clássica |
| É executado em | Agent, DeploymentGroup |
| Exigências | Nenhuma |
| Capacidades | Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa. |
| Restrições de comandos | Qualquer |
| Variáveis de definição | Qualquer |
| Versão do agente | Todas as versões de agente suportadas. |
| Categoria da tarefa | Compilação |