AdvancedSecurity-Codeql-Analyze@1 - Advanced Security 执行 CodeQL 分析 v1 任务

分析Azure Repos Git 存储库中的代码,以查找安全漏洞和编码错误。 必须为要扫描的存储库启用 Azure DevOps GitHub Advanced Security

语法

# Advanced Security Perform CodeQL analysis v1
# Finalizes the CodeQL database and runs the analysis queries.
- task: AdvancedSecurity-Codeql-Analyze@1
  inputs:
    #WaitForProcessing: false # boolean. Enable Wait for Processing. Default: false.
    #WaitForProcessingInterval: '5' # string. Optional. Use when WaitForProcessing = true. Wait for Processing Time Interval. Default: 5.
    #WaitForProcessingTimeout: '120' # string. Optional. Use when WaitForProcessing = true. Wait for Processing Timeout. Default: 120.

输入

WaitForProcessing - 启用“等待处理”
boolean. 默认值:false

在完成之前,请等待高级安全处理已发布的 SARIF 文件。


WaitForProcessingInterval - 等待处理时间间隔
string. 可选。 在 时 WaitForProcessing = true使用 。 默认值:5

每次调用高级安全以检查 SARIF 处理状态之间等待的时间(以秒为单位)。


WaitForProcessingTimeout - 等待处理超时
string. 可选。 在 时 WaitForProcessing = true使用 。 默认值:120

等待高级安全在完成之前处理 SARIF 文件的时间(以秒为单位)。


任务控制选项

除了任务输入,所有任务都有控制选项。 有关详细信息,请参阅 控制选项和常见任务属性

输出变量

无。

备注

重要

仅Azure Repos Git 存储库支持此任务。

先决条件

为使任务成功完成并填充扫描的存储库的“高级安全”选项卡,必须先为该存储库启用 高级安全 ,然后才能运行包含依赖项扫描任务的生成。

该任务可在自承载代理和 Microsoft 托管代理上运行。 对于自托管代理,请参阅 其他自承载代理设置说明

管道必须按以下顺序调用任务。

  1. 初始化 CodeQL
  2. 自动生成 (或自定义生成任务)
  3. 执行 CodeQL 分析

AutoBuild 任务是可选的,可以替换为自定义生成任务。 必须运行 AutoBuild 或自定义生成任务才能分析项目。

分析任务必须显示在初始化任务之后才能成功完成。

# Initialize CodeQL database 
- task: AdvancedSecurity-Codeql-Init@1
  inputs: 
    language: csharp 
  displayName: 'Advanced Security Initialize CodeQL' 

# Build project using Autobuild or your own custom build steps 
- task: AdvancedSecurity-Codeql-Autobuild@1
  displayName: 'Advanced Security Autobuild' 

# Run analysis 
- task: AdvancedSecurity-Codeql-Analyze@1 
  displayName: 'Advanced Security Code Scanning' 

要求

要求 说明
管道类型 YAML,经典内部版本,经典版本
运行平台 Agent、DeploymentGroup
需求
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任意
可设置的变量 任意
代理版本 所有支持的代理版本。
任务类别 构建

另请参阅