このタスクを使用して、SonarQube 解析構成を準備します。
注
このタスクは推奨されていません。 SonarQubePrepare@8を使いましょう。
注
SonarQube タスクは、Azure DevOps Services にプレインストールされている Azure DevOps の SonarQube 拡張機能の一部です。 SonarQube タスクと SonarQube タスクの詳細とサポートについては、「
構文
# Prepare Analysis Configuration v5
# Prepare SonarQube analysis configuration.
- task: SonarQubePrepare@5
inputs:
SonarQube: # string. Required. SonarQube Server Endpoint.
scannerMode: 'MSBuild' # 'MSBuild' | 'Other' | 'CLI'. Required. Choose the way to run the analysis. Default: MSBuild.
#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 サーバーエンドポイントを指定します。 作成するには、[ Manage ] リンクをクリックし、新しい SonarQube サーバー エンドポイントを作成して、サーバーの URL とトークンを入力します。
scannerMode
-
解析の実行方法の選択
string。 必須。 使用できる値: MSBuild (MSBuild と統合)、 Other (Maven または Gradle と統合)、 CLI (スタンドアロン スキャナーを使用)。 既定値: MSBuild。
MSBuildの
- このタスクは、MSBuild タスクの前に置きます。
- MSBuild/VSTest タスクの後に
Run Code Analysisタスクを追加します。
Maven/グラドル
- このタスクをMaven / Gradleタスクの前に置きます。
- Maven/Gradleタスク設定の
Run SonarQube Analysisチェックボックスにチェックを入れます。
その他
- それ以外の場合は、スタンドアロンスキャナー(sonar-scanner)を使用し、このタスクですべての構成を設定してから、
Run Code Analysisタスクを追加できます。
configMode
-
モード
string。
scannerMode = CLIする場合に必要です。 使用できる値: file (ソース コード (sonar-project.properties) と共に構成を保存する)、 manual (構成を手動で提供)。 既定値: file。
優先する設定方法を指定します。
configFile
-
設定ファイル
string。 任意。
scannerMode = CLI && configMode = fileするときに使用します。 既定値: sonar-project.properties。
構成設定とプロジェクトのプロパティを指定します。 Azure DevOps の SonarQube 拡張機能の詳細については、こちらを参照してください。
cliProjectKey
-
プロジェクトキー
string。
scannerMode = CLI && configMode = manualする場合に必要です。
SonarQube プロジェクトの一意キーを指定します。 たとえば、sonar.projectKey のようにします。
projectKey
-
プロジェクトキー
string。
scannerMode = 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
-
ソースディレクトリのルート
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。
スキャナーに渡す 追加のプロパティ を指定します。 各 key=value ペアを新しい行に指定します。
タスク制御オプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。
出力変数
なし。
注釈
注
このタスクは非推奨です。 SonarQubePrepare@7を使用します。
- MSBuild 以外のプロジェクトをサポートします。 このタスクでは、MSBuild 以外のプロジェクトの分析を構成することもできます。
要求事項
| 要件 | 説明 |
|---|---|
| パイプラインの種類 | YAML、クラシック ビルド |
| 実行日 | エージェント、DeploymentGroup |
| の需要 | 無し |
| 機能 | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
| コマンドの制限 | [任意] |
| 設定可能な変数 | [任意] |
| エージェントのバージョン | 2.144.0 以上 |
| タスク カテゴリ | 建築する |