AdvancedSecurity-Codeql-Init@1 – Avancerad säkerhet – Initiera CodeQL v1-uppgift
Initierar CodeQL-databasen inför skapandet.
Du måste ha GitHub Advanced Security för Azure DevOps aktiverat för lagringsplatsen som genomsöks.
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).
Indata
languages - Språk som ska analyseras
string. Tillåtna värden: csharp, cpp, go, java, javascript, python, ruby, swift.
Programmeringsspråket som ska analyseras. Flera språk kan avgränsas med ett kommatecken.
Du kan ange språket här i uppgiften eller ange språket i en pipelinevariabel med namnet advancedsecurity.codeql.language. Om båda anges har värdet som anges i aktiviteten företräde.
querysuite - CodeQL Query Suite som ska användas för analys.
string. Tillåtna värden: Select a query suite..., code-scanning, security-extended, security-experimental, security-and-quality. Standardvärde: Select a query suite....
Frågesviten, d.v.s. regeluppsättning, som används för analys. Du kan ange värdet här i aktiviteten eller ange det i en pipelinevariabel med namnet advancedsecurity.codeql.querysuite. Om båda anges har värdet som anges i aktiviteten företräde. Standardvärdet är Select a query suite... som anger att frågesviten måste anges i variabeln advancedsecurity.codeql.querysuite .
ram - Alternativ för att styra RAM-användning i MB
string.
Ange den totala mängden RAM-minne som frågeutvärderingsorn ska tillåtas använda.
Du kan ange ram här i uppgiften eller ange den i en pipelinevariabel med namnet advancedsecurity.codeql.ram. Om båda anges har värdet som anges i aktiviteten företräde.
threads - Använd så här många trådar för att utvärdera frågor
string.
Du kan skicka 0 för att använda en tråd per kärna på datorn, eller -N för att lämna N-kärnor oanvända (förutom att fortfarande använda minst en tråd).
Du kan ange threads här i uppgiften eller ange den i en pipelinevariabel med namnet advancedsecurity.codeql.threads. Om båda anges har värdet som anges i aktiviteten företräde.
codeqlpathstoignore - Ange en lista över sökvägar som ska undantas i CodeQL-analysen
string.
Du kan ange flera sökvägar avgränsade med kommatecken. Sökvägarna måste vara i förhållande till där sourcesfolder CodeQL körs, vilket är standardvärdet för Build.SourcesDirectory pipelinemiljövariabeln. Om du till exempel vill ignorera $(Build.SourcesDirectory)/donotscan katalogen anger du codeqlpathstoignore: donotscan i stället codeqlpathstoignore: $(Build.SourcesDirectory)/donotscanför .
codeqlpathstoinclude - Ange en lista över ytterligare sökvägar som ska ingå i CodeQL-analysen
string.
Du kan ange flera sökvägar avgränsade med kommatecken. Sökvägarna måste vara i förhållande till där sourcesfolder CodeQL körs, vilket är standardvärdet för Build.SourcesDirectory pipelinemiljövariabeln. Om du till exempel vill inkludera $(Build.SourcesDirectory)/app katalogen anger du codeqlpathstoinclude: app i stället codeqlpathstoinclude: $(Build.SourcesDirectory)/appför .
sourcesfolder - Anger den mapp som innehåller källorna som ska analyseras
string.
Om du inte anger det här värdet används standardkällans mapp för pipelineinfrastrukturen (tillhandahålls av variabeln Build.SourcesDirectory ).
loglevel - Ange loggnivå för CodeQL-analysen
string. Tillåtna värden: 0 (Varning), 1 (Utförlig), 2 (Felsökning) _ (Standard (Varning)). Standardvärde: _.
Ange loggningsnivån.
Du kan ange loglevel här i uppgiften eller ange den i en pipelinevariabel med namnet advancedsecurity.codeql.loglevel. Om båda anges har värdet som anges i aktiviteten företräde, såvida inte standardvärdet _ för loglevel i aktiviteten anges. Om _ anges används värdet från advancedsecurity.codeql.loglevel om det är tillgängligt.
configfilepath - Använd detta för att aktivera anpassad frågeanalys i codeql (sökvägen måste vara absolut).
string.
Om sökvägen inte anges fortsätter codeql-analysen med standardfrågor.
codeqltoolsdirectory - Ange en anpassad CodeQL-verktygskatalog (sökvägen måste vara absolut)
string.
Om sökvägen inte anges används standardvärdet $agent_toolsdirectory för .
Kontrollalternativ för aktivitet
Alla aktiviteter har kontrollalternativ utöver sina aktivitetsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.
Utdatavariabler
Inga.
Kommentarer
Du måste ha GitHub Advanced Security för Azure DevOps aktiverat för lagringsplatsen som genomsöks.
Viktigt
Den här uppgiften stöds endast med Git-lagringsplatser för Azure Repos.
Pipelinen måste anropa aktiviteterna i följande ordning.
- Initiera CodeQL
- Skapa automatiskt (eller dina anpassade bygguppgifter)
- Utföra CodeQL-analys
Autobuild-uppgiften är valfri och kan ersättas med dina anpassade bygguppgifter. Antingen AutoBuild eller dina anpassade bygguppgifter måste köras för att projektet ska kunna analyseras.
Krav
| Krav | Beskrivning |
|---|---|
| Pipelinetyper | YAML, klassisk version, klassisk version |
| Körs på | Agent, DeploymentGroup |
| Krav | Ingen |
| Funktioner | Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet. |
| Kommandobegränsningar | Valfri |
| Inställningsbara variabler | Valfri |
| Agentversion | Alla agentversioner som stöds. |
| Uppgiftskategori | Build |