SonarQubePrepare@5 - 分析構成 v5 タスクの準備
このタスクを使用して、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 タスクの前にこのタスクを配置します。
Run Code AnalysisMSBuild/VSTest タスクの後にタスクを追加します。
Maven/Gradle
- Maven/Gradle タスクの前にこのタスクを配置します。
Run SonarQube AnalysisMaven/Gradle タスク構成のチェックボックスをオンにします。
Others
- それ以外の場合は、スタンドアロン スキャナー (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は必須です。 既定値: .。
ソース ファイルを含むルート ディレクトリへのパスを指定します。 この値は SonarQube プロパティに sonar.sources 設定されます。
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 ペアを指定します。
タスク コントロールのオプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。
出力変数
[なし] :
解説
- MSBuild 以外のプロジェクトをサポートする: このタスクでは、MSBuild 以外のプロジェクトの分析を構成することもできます。
必要条件
| 要件 | 説明 |
|---|---|
| パイプラインの種類 | YAML、クラシック ビルド |
| 上で実行 | エージェント、DeploymentGroup |
| 確認要求 | なし |
| Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
| コマンドの制限 | Any |
| 設定可能な変数 | Any |
| エージェントのバージョン | 2.144.0 以上 |
| タスクのカテゴリ | Build |