Condividi tramite


Attività AdvancedSecurity-Codeql-Init@1 - Attività Advanced Security Initialize CodeQL v1

Inizializza il database CodeQL in preparazione per la compilazione.

È necessario disporre di GitHub Advanced Security per Azure DevOps abilitato per l'analisi del repository.

Sintassi

# 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).

Input

languages - Lingue da analizzare
string. Valori consentiti: cppjavagoswiftcsharpjavascriptpythonruby, .

Linguaggio di programmazione da analizzare. Più lingue possono essere separate da una virgola.

È possibile impostare la lingua qui nell'attività oppure specificare la lingua in una variabile di pipeline denominata advancedsecurity.codeql.language. Se entrambi sono impostati, il valore specificato nell'attività ha la precedenza.


querysuite - CodeQL Query Suite da usare per l'analisi.
string. Valori consentiti: Select a query suite..., code-scanning, security-experimentalsecurity-extended, security-and-quality. Valore predefinito: Select a query suite....

Set di regole, ad esempio, usato per l'analisi. È possibile specificare il valore qui nell'attività oppure specificarlo in una variabile di pipeline denominata advancedsecurity.codeql.querysuite. Se entrambi sono impostati, il valore specificato nell'attività ha la precedenza. Il valore predefinito è Select a query suite... che indica che la suite di query deve essere specificata nella advancedsecurity.codeql.querysuite variabile.


ram - Opzioni per controllare l'utilizzo della RAM in MB
string.

Impostare la quantità totale di RAM che deve essere usata dall'analizzatore di query.

È possibile specificare ram qui nell'attività oppure specificarla in una variabile di pipeline denominata advancedsecurity.codeql.ram. Se entrambi sono impostati, il valore specificato nell'attività ha la precedenza.


threads - Usare questo numero di thread per valutare le query
string.

È possibile passare 0 per usare un thread per core nel computer o -N per lasciare inutilizzati i core N(ad eccezione di almeno un thread).

È possibile specificare threads qui nell'attività oppure specificarla in una variabile di pipeline denominata advancedsecurity.codeql.threads. Se entrambi sono impostati, il valore specificato nell'attività ha la precedenza.


codeqlpathstoignore - Impostare un elenco di percorsi da escludere nell'analisi CodeQL
string.

È possibile fornire più percorsi separati da virgole. I percorsi devono essere relativi alla sourcesfolder posizione in cui CodeQL è in esecuzione, che per impostazione predefinita viene impostata sulla variabile di ambiente della Build.SourcesDirectory pipeline. Ad esempio, per ignorare la $(Build.SourcesDirectory)/donotscan directory, impostare codeqlpathstoignore: donotscan anziché codeqlpathstoignore: $(Build.SourcesDirectory)/donotscan.


codeqlpathstoinclude - Impostare un elenco di percorsi aggiuntivi da includere nell'analisi CodeQL
string.

È possibile fornire più percorsi separati da virgole. I percorsi devono essere relativi alla sourcesfolder posizione in cui CodeQL è in esecuzione, che per impostazione predefinita viene impostata sulla variabile di ambiente della Build.SourcesDirectory pipeline. Ad esempio, per includere la $(Build.SourcesDirectory)/app directory, impostare codeqlpathstoinclude: app anziché codeqlpathstoinclude: $(Build.SourcesDirectory)/app.


sourcesfolder - Imposta la cartella contenente le origini da analizzare
string.

Se non si specifica questo valore, viene usata la cartella origini predefinite per l'infrastruttura della Build.SourcesDirectory pipeline (fornita dalla variabile).


loglevel - Impostare il livello di log per l'analisi codeQL
string. Valori consentiti: 0 (avviso), (verbose), 2 (debug), 1_ (impostazione predefinita (avviso)). Valore predefinito: _.

Specificare il livello di registrazione.

È possibile specificare loglevel qui nell'attività oppure specificarla in una variabile di pipeline denominata advancedsecurity.codeql.loglevel. Se entrambi sono impostati, il valore specificato nell'attività ha la precedenza, a meno che non sia specificato il valore _ predefinito per loglevel nell'attività. Se _ specificato, il valore da advancedsecurity.codeql.loglevel viene usato se disponibile.


configfilepath - Usare questa opzione per abilitare l'analisi di query personalizzata in codeql (percorso deve essere assoluto).
string.

Se il percorso non viene specificato, l'analisi codeql procederà con le query predefinite.


codeqltoolsdirectory - Impostare una directory degli strumenti CodeQL personalizzata (percorso deve essere assoluto)
string.

Se il percorso non viene specificato, verrà utilizzato il valore predefinito di $agent_toolsdirectory .


Opzioni di controllo delle attività

Tutte le attività dispongono di opzioni di controllo oltre ai relativi input attività. Per altre informazioni, vedere Opzioni di controllo e proprietà comuni delle attività.

Variabili di output

Nessuno.

Osservazioni

È necessario disporre di GitHub Advanced Security per Azure DevOps abilitato per l'analisi del repository.

Importante

Questa attività è supportata solo con Azure Repos repository Git.

La pipeline deve chiamare le attività nell'ordine seguente.

  1. Inizializzare CodeQL
  2. AutoBuild (o le attività di compilazione personalizzate)
  3. Eseguire l'analisi codeQL

L'attività AutoBuild è facoltativa e può essere sostituita con le attività di compilazione personalizzate. AutoBuild o le attività di compilazione personalizzate devono essere eseguite per l'analisi del progetto.

Requisiti

Requisito Descrizione
Tipi di pipeline YAML, build classica, versione classica
Esecuzione in Agente, DeploymentGroup
Richieste Nessuno
Capabilities Questa attività non soddisfa le richieste per le attività successive nel processo.
Restrizioni dei comandi Qualsiasi
Variabili impostabili Qualsiasi
Versione agente Tutte le versioni dell'agente supportate.
Categoria attività Compilazione

Vedi anche