共用方式為


SonarQubePrepare@6 - 準備分析設定 v6 工作

準備 SonarQube 分析組態。

注意

SonarQube 工作是 Azure DevOps 的 SonarQube 延伸模組的一部分,其預安裝在 Azure DevOps Services 中。 如需 SonarQube 和 SonarQube 工作的詳細資訊和支援,請參閱 Azure DevOps的 sonarQube 擴充功能 SonarQube - Visual Studio Marketplace,以及 Sonar Community

語法

# Prepare Analysis Configuration v6
# Prepare SonarQube analysis configuration.
- task: SonarQubePrepare@6
  inputs:
    SonarQube: # string. Required. SonarQube Server Endpoint. 
    scannerMode: 'MSBuild' # 'MSBuild' | 'Other' | 'CLI'. Required. Choose the way to run the analysis. Default: MSBuild.
    #msBuildVersion: # string. Optional. Use when scannerMode = MSBuild. Scanner MSBuild Version. 
    #cliVersion: # string. 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 = MSBuild. Project Key. 
    #cliProjectName: # string. Optional. Use when scannerMode = CLI && configMode = manual. Project Name. 
    #projectName: # string. Optional. Use when scannerMode = MSBuild. 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 = MSBuild. 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。 必填。 允許的值:MSBuild(與 MSBuild 整合)、Other(與 Maven 或 Gradle 整合)、CLI(使用獨立掃描器)。 預設值:MSBuild

MSBuild

  • 將這項工作放在 MSBuild 工作之前
  • 在 MSBuild/VSTest 工作之後新增「執行程式代碼分析」工作

Maven/Gradle

  • 將這項工作放在 Maven/Gradle 工作之前
  • 勾選 Maven/Gradle 工作組態中的 [執行 SonarQube 分析] 複選框。

別人

若為其他情況,您可以使用獨立掃描器(sonar-scanner),並使用這項工作設定所有設定,然後新增「執行程式碼分析」工作。


msBuildVersion - 掃描器 MSBuild 版本
string。 自選。 scannerMode = MSBuild時使用 。

指定要使用的 MSBuild 掃描器版本。 您可以在這裏 版本,


cliVersion - 掃描器 CLI 版本
string。 自選。 scannerMode = CLI時使用 。

指定要使用的 CLI 掃描器版本。 您可以在這裏 版本,


configMode - 模式
stringscannerMode = CLI時為必要項。 允許的值:file(使用我的原始程式碼儲存組態(sonar-project.properties))、manual(手動提供設定)。 預設值:file

選擇您慣用的組態方法。


configFile - 配置檔案
string。 自選。 scannerMode = CLI && configMode = file時使用 。 預設值:sonar-project.properties

如需詳細資訊,請參閱這裡


cliProjectKey - 項目金鑰
stringscannerMode = CLI && configMode = manual時為必要項。

SonarQube 專案的唯一索引鍵,也就是 sonar.projectKey


projectKey - 項目金鑰
stringscannerMode = MSBuild時為必要項。

SonarQube 專案的唯一索引鍵,也就是 sonar.projectKey


cliProjectName - 項目名稱
string。 自選。 scannerMode = CLI && configMode = manual時使用 。

SonarQube 項目名稱,也就是 sonar.projectName


projectName - 項目名稱
string。 自選。 scannerMode = MSBuild時使用 。

SonarQube 項目名稱,也就是 sonar.projectName


cliProjectVersion - 專案版本
string。 自選。 scannerMode = CLI && configMode = manual時使用 。 預設值:1.0

SonarQube 專案版本,即 sonar.projectVersion


projectVersion - 專案版本
string。 自選。 scannerMode = MSBuild時使用 。 預設值:1.0

SonarQube 專案版本,即 sonar.projectVersion


cliSources - 來源目錄根目錄
stringscannerMode = 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

要傳遞至掃描器的其他屬性。 在新行上指定每個key=value組。


工作控制選項

除了工作輸入之外,所有工作都有控制選項。 如需詳細資訊,請參閱 控制項選項和一般工作屬性

輸出變數

沒有。

言論

注意

SonarQube 工作是 Azure DevOps 的 SonarQube 延伸模組的一部分,其預安裝在 Azure DevOps Services 中。 如需 SonarQube 和 SonarQube 工作的詳細資訊和支援,請參閱 Azure DevOps的 sonarQube 擴充功能 SonarQube - Visual Studio Marketplace,以及 Sonar Community

要求

要求 描述
管線類型 YAML,傳統組建
執行於 Agent、DeploymentGroup
需求 沒有
功能 此工作不符合作業中後續工作的任何需求。
命令限制 任何
Settable 變數 任何
代理程式版本 3.218.0 或更新
工作類別