通过

SonarQubePrepare@7 - 准备分析配置 v7 任务

  • 项目

准备 SonarQube 分析配置。

注意

SonarQube 任务是 Azure DevOps 的 SonarQube 扩展的一部分，该扩展预安装在 Azure DevOps Services 中。 有关 SonarQube 和 SonarQube 任务的详细信息和支持，请参阅 Azure DevOps的 SonarQube 扩展、SonarQube - Visual Studio Marketplace，以及 Sonar Community。

语法

# Prepare Analysis Configuration v7
# Prepare SonarQube Server analysis configuration.
- task: SonarQubePrepare@7
  inputs:
    SonarQube: # string. Required. SonarQube Server Endpoint. 
    scannerMode: 'dotnet' # 'dotnet' | 'cli' | 'other'. Required. Choose the way to run the analysis. Default: dotnet.
    #msBuildVersion: # string. Alias: dotnetScannerVersion. Optional. Use when scannerMode = dotnet. .NET Scanner Version. 
    #cliVersion: # string. Alias: cliScannerVersion. Optional. Use when scannerMode = cli. Scanner CLI Version. 
    #configMode: 'file' # 'file' | 'manual'. Required when scannerMode = cli. Mode. Default: file.
    #configFile: 'sonar-project.properties' # string. Optional. Use when scannerMode = cli && configMode = file. Settings File. Default: sonar-project.properties.
    #cliProjectKey: # string. Required when scannerMode = cli && configMode = manual. Project Key. 
    projectKey: # string. Required when scannerMode = dotnet. Project Key. 
    #cliProjectName: # string. Optional. Use when scannerMode = cli && configMode = manual. Project Name. 
    #projectName: # string. Optional. Use when scannerMode = dotnet. Project Name. 
    #cliProjectVersion: '1.0' # string. Optional. Use when scannerMode = cli && configMode = manual. Project Version. Default: 1.0.
    #projectVersion: '1.0' # string. Optional. Use when scannerMode = dotnet. Project Version. Default: 1.0.
    #cliSources: '.' # string. Required when scannerMode = cli && configMode = manual. Sources directory root. Default: ..
  # Advanced
    #extraProperties: # string. Additional Properties.

输入

SonarQube - SonarQube 服务器终结点
string。 必填。

为项目选择 SonarQube 服务器终结点。 若要创建一个，请单击“管理”链接并创建新的 SonarQube 服务器终结点，输入服务器 URL 和令牌。


scannerMode - 选择运行分析 的方式
string。 必填。 允许的值：dotnet（与 .NET 集成）、cli（使用独立 SonarScanner CLI）、other（与 Maven 或 Gradle 集成）。 默认值：dotnet。

  • dotnet（与 .NET 集成）
    • 将此任务置于生成任务之前
    • 在 MSBuild/VSTest 任务后添加“运行代码分析”任务
  • other （与 Maven 或 Gradle 集成）
    • 将此任务置于 Maven/Gradle 任务之前
    • 勾选 Maven/Gradle 任务配置中的“运行 SonarQube 分析”复选框。
  • cli
    • 对于其他情况，可以使用独立扫描程序（sonar-scanner）并设置此任务的所有配置，然后添加“运行代码分析”任务。

msBuildVersion - .NET 扫描程序版本
输入别名：dotnetScannerVersion。 string。 自选。 当 scannerMode = dotnet时使用。

指定要使用的 .NET 扫描程序的版本。 此处 版本。


cliVersion - 扫描程序 CLI 版本
输入别名：cliScannerVersion。 string。 自选。 当 scannerMode = cli时使用。

指定要使用的 CLI 扫描程序的版本。 此处 版本。


configMode - 模式
string。 scannerMode = cli时是必需的。 允许的值：file（使用源代码存储配置（sonar-project.properties），manual（手动提供配置）。 默认值：file。

选择首选配置方法。


configFile - 设置文件
string。 自选。 当 scannerMode = cli && configMode = file时使用。 默认值：sonar-project.properties。

此处提供了详细信息。


cliProjectKey - 项目密钥
string。 scannerMode = cli && configMode = manual时是必需的。

SonarQube 项目唯一键，即 sonar.projectKey。


projectKey - 项目密钥
string。 scannerMode = dotnet时是必需的。

SonarQube 项目唯一键，即 sonar.projectKey。


cliProjectName - 项目名称
string。 自选。 当 scannerMode = cli && configMode = manual时使用。

SonarQube 项目名称，即 sonar.projectName。


projectName - 项目名称
string。 自选。 当 scannerMode = dotnet时使用。

SonarQube 项目名称，即 sonar.projectName。


cliProjectVersion - 项目版本
string。 自选。 当 scannerMode = cli && configMode = manual时使用。 默认值：1.0。

SonarQube 项目版本，即 sonar.projectVersion。


projectVersion - 项目版本
string。 自选。 当 scannerMode = dotnet时使用。 默认值：1.0。

SonarQube 项目版本，即 sonar.projectVersion。


cliSources - 源目录根
string。 scannerMode = cli && configMode = manual时是必需的。 默认值：.。

包含源文件的根目录的路径。 此值设置为 sonar.sources SonarQube 属性。


extraProperties - 其他属性
string。 默认值：# Additional properties that will be passed to the scanner, \n# Put one key=value per line, example:\n# sonar.exclusions=**/*.bin。

要传递给扫描程序的其他属性。 在新行上指定每个键=值对。


任务控制选项

除任务输入之外，所有任务都具有控制选项。 有关详细信息，请参阅 控件选项和常见任务属性。

输出变量

没有。

言论

注意

SonarQube 任务是 Azure DevOps 的 SonarQube 扩展的一部分，该扩展预安装在 Azure DevOps Services 中。 有关 SonarQube 和 SonarQube 任务的详细信息和支持，请参阅 Azure DevOps的 SonarQube 扩展、SonarQube - Visual Studio Marketplace，以及 Sonar Community。

要求

要求 描述
管道类型 YAML，经典生成
运行时间 代理，DeploymentGroup
需求 没有
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任何
Settable 变量 任何
代理版本 3.218.0 或更高版本
任务类别 建