AdvancedSecurity-Codeql-Init@1 – Advanced Security Initialize CodeQL v1 feladat
Inicializálja a CodeQL-adatbázist az építés előkészítése során.
A vizsgálat alatt álló adattárhoz engedélyeznie kell az Azure DevOps GitHub Advanced Security.
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).
Bevitelek
languages - Elemezni kívánt nyelvek
string. Engedélyezett értékek: csharp, cpp, go, java, javascript, python, ruby. swift
Az elemezni kívánt programozási nyelv. Több nyelv vesszővel elválasztható.
Itt állíthatja be a nyelvet a feladatban, vagy megadhatja a nyelvet egy nevű advancedsecurity.codeql.languagefolyamatváltozóban. Ha mindkettő be van állítva, a tevékenységben megadott érték elsőbbséget élvez.
querysuite - Elemzéshez használható CodeQL Query Suite.
string. Engedélyezett értékek: Select a query suite..., code-scanning, security-extended, security-experimental, security-and-quality. Alapértelmezett érték: Select a query suite....
Az elemzéshez használt lekérdezési csomag, azaz a szabálykészlet. Itt adhatja meg az értéket a tevékenységben, vagy megadhatja egy nevű advancedsecurity.codeql.querysuitefolyamatváltozóban. Ha mindkettő be van állítva, a tevékenységben megadott érték elsőbbséget élvez. Az alapértelmezett érték azt Select a query suite... jelzi, hogy a lekérdezési csomagot meg kell adni a advancedsecurity.codeql.querysuite változóban.
ram - A RAM-használat szabályozásának lehetőségei MB-ban
string.
Adja meg a lekérdezés-kiértékelő által használható RAM teljes mennyiségét.
Itt adhatja meg ram a feladatot, vagy megadhatja egy nevű advancedsecurity.codeql.ramfolyamatváltozóban. Ha mindkettő be van állítva, a tevékenységben megadott érték elsőbbséget élvez.
threads - Ennyi szál használata lekérdezések kiértékeléséhez
string.
0-t adhat át, ha magonként egy szálat használ a gépen, vagy -N-et az N magok használaton kívüli hagyásához (kivéve, ha legalább egy szálat használ).
Itt adhatja meg threads a feladatot, vagy megadhatja egy nevű advancedsecurity.codeql.threadsfolyamatváltozóban. Ha mindkettő be van állítva, a tevékenységben megadott érték elsőbbséget élvez.
codeqlpathstoignore - A CodeQL-elemzésben kizárandó elérési utak listájának beállítása
string.
Több útvonalat is megadhat vesszővel elválasztva. Az elérési utaknak a sourcesfolder CodeQL futtatásának helyén kell lenniük, amely alapértelmezés szerint a folyamat környezeti változója Build.SourcesDirectory . Ha például figyelmen kívül szeretné hagyni a könyvtárat, állítsa be codeqlpathstoignore: donotscan a $(Build.SourcesDirectory)/donotscan értéket a helyettcodeqlpathstoignore: $(Build.SourcesDirectory)/donotscan.
codeqlpathstoinclude - A CodeQL-elemzésbe belefoglalandó további elérési utak listájának beállítása
string.
Több útvonalat is megadhat vesszővel elválasztva. Az elérési utaknak a sourcesfolder CodeQL futtatásának helyén kell lenniük, amely alapértelmezés szerint a folyamat környezeti változója Build.SourcesDirectory . Ha például a könyvtárat szeretné belefoglalni, állítsa be a $(Build.SourcesDirectory)/app értéket codeqlpathstoinclude: app a helyett codeqlpathstoinclude: $(Build.SourcesDirectory)/app.
sourcesfolder - Beállítja az elemezni kívánt forrásokat tartalmazó mappát
string.
Ha nem adja meg ezt az értéket, a rendszer a folyamatinfrastruktúra alapértelmezett forrásmappáját használja (a Build.SourcesDirectory változó biztosítja).
loglevel - A CodeQL-elemzés naplószintjének beállítása
string. Engedélyezett értékek: 0 (Figyelmeztetés), 1 (Részletes), 2 (Hibakeresés), _ (Alapértelmezett (Figyelmeztetés)). Alapértelmezett érték: _.
Adja meg a naplózás szintjét.
Itt adhatja meg loglevel a feladatot, vagy megadhatja egy nevű advancedsecurity.codeql.loglevelfolyamatváltozóban. Ha mindkettő be van állítva, a tevékenységben megadott érték elsőbbséget élvez, kivéve, ha a tevékenység alapértelmezett értéke _loglevel meg van adva. Ha _ meg van adva, a rendszer a forrásértéket advancedsecurity.codeql.loglevel használja, ha elérhető.
configfilepath - Ezzel engedélyezheti az egyéni lekérdezéselemzést a codeqlben (az elérési útnak abszolútnak kell lennie).
string.
Ha az elérési út nincs megadva, akkor a codeql-elemzés az alapértelmezett lekérdezésekkel folytatódik.
codeqltoolsdirectory - Egyéni CodeQL-eszközök könyvtárának beállítása (az elérési útnak abszolútnak kell lennie)
string.
Ha az elérési út nincs megadva, a rendszer az alapértelmezett értéket $agent_toolsdirectory használja.
Feladatvezérlési lehetőségek
Minden feladathoz tartoznak vezérlési lehetőségek is a feladat bemenetei mellett. További információ: Vezérlési beállítások és gyakori feladattulajdonságok.
Kimeneti változók
Nincsenek.
Megjegyzések
A vizsgálat alatt álló adattárhoz engedélyeznie kell az Azure DevOps GitHub Advanced Security.
Fontos
Ezt a feladatot csak az Azure Repos Git-adattárak támogatják.
A folyamatnak a következő sorrendben kell meghívnia a tevékenységeket.
- CodeQL inicializálása
- Automatikusan összeállított (vagy egyéni buildelési feladatok)
- CodeQL-elemzés végrehajtása
Az automatikusan összeállított feladat nem kötelező, és lecserélhető az egyéni buildelési feladatokra. Az automatikusan létrehozott vagy az egyéni buildelési feladatokat futtatni kell a projekt elemzéséhez.
Követelmények
| Követelmény | Leírás |
|---|---|
| Folyamattípusok | YAML, klasszikus build, klasszikus kiadás |
| Futtatás | Ügynök, DeploymentGroup |
| Igények | None |
| Képességek | Ez a feladat nem felel meg a feladat későbbi tevékenységeire vonatkozó követelményeknek. |
| Parancskorlátozások | Bármelyik |
| Változók beállítása | Bármelyik |
| Ügynök verziója | Minden támogatott ügynökverzió. |
| Feladatkategória | Build |