Maven@2 - Maven v2 タスク

このタスクを使用して、Apache Maven を使用してビルド、テスト、デプロイします。

このバージョンのタスクは非推奨です。Maven@4を使用します。

構文

# Maven v2
# Build, test, and deploy with Apache Maven.
- task: Maven@2
  inputs:
    mavenPOMFile: 'pom.xml' # string. Required. Maven POM file. Default: pom.xml.
    #goals: 'package' # string. Goal(s). Default: package.
    #options: # string. Options. 
  # JUnit Test Results
    #publishJUnitResults: true # boolean. Publish to Azure Pipelines. Default: true.
    testResultsFiles: '**/TEST-*.xml' # string. Required when publishJUnitResults = true. Test results files. Default: **/TEST-*.xml.
    #testRunTitle: # string. Optional. Use when publishJUnitResults = true. Test run title. 
    #allowBrokenSymlinks: true # boolean. Alias: allowBrokenSymbolicLinks. Optional. Use when publishJUnitResults = true. Allow broken symbolic links. Default: true.
  # Code Coverage
    #codeCoverageToolOption: 'None' # 'None' | 'Cobertura' | 'JaCoCo'. Alias: codeCoverageTool. Code coverage tool. Default: None.
    #codeCoverageClassFilter: # string. Alias: classFilter. Optional. Use when codeCoverageTool != None. Class inclusion/exclusion filters. 
    #codeCoverageClassFilesDirectories: # string. Alias: classFilesDirectories. Optional. Use when codeCoverageTool = JaCoCo. Class files directories. 
    #codeCoverageSourceDirectories: # string. Alias: srcDirectories. Optional. Use when codeCoverageTool = JaCoCo. Source files directories. 
    #codeCoverageFailIfEmpty: false # boolean. Alias: failIfCoverageEmpty. Optional. Use when codeCoverageTool != None. Fail when code coverage results are missing. Default: false.
    #codeCoverageRestoreOriginalPomXml: false # boolean. Alias: restoreOriginalPomXml. Optional. Use when codeCoverageTool != None. Restore original pom.xml after task execution. Default: false.
  # Advanced
    javaHomeOption: 'JDKVersion' # 'JDKVersion' | 'Path'. Alias: javaHomeSelection. Required. Set JAVA_HOME by. Default: JDKVersion.
    #jdkVersionOption: 'default' # 'default' | '1.21' | '1.17' | '1.11' | '1.10' | '1.9' | '1.8' | '1.7' | '1.6'. Alias: jdkVersion. Optional. Use when javaHomeSelection = JDKVersion. JDK version. Default: default.
    #jdkDirectory: # string. Alias: jdkUserInputPath. Required when javaHomeSelection = Path. JDK path. 
    #jdkArchitectureOption: 'x64' # 'x86' | 'x64'. Alias: jdkArchitecture. Optional. Use when jdkVersion != default. JDK architecture. Default: x64.
    mavenVersionOption: 'Default' # 'Default' | 'Path'. Alias: mavenVersionSelection. Required. Maven version. Default: Default.
    #mavenDirectory: # string. Alias: mavenPath. Required when mavenVersionSelection = Path. Maven path. 
    #mavenSetM2Home: false # boolean. Optional. Use when mavenVersionSelection = Path. Set M2_HOME variable. Default: false.
    #mavenOptions: '-Xmx1024m' # string. Alias: mavenOpts. Set MAVEN_OPTS to. Default: -Xmx1024m.
    #mavenAuthenticateFeed: true # boolean. Alias: mavenFeedAuthenticate. Authenticate with Artifacts feeds. Default: true.
  # Code Analysis
    #sonarQubeRunAnalysis: false # boolean. Alias: sqAnalysisEnabled. Run SonarQube or SonarCloud analysis. Default: false.
    #isJacocoCoverageReportXML: false # boolean. Optional. Use when sqAnalysisEnabled = true && codeCoverageTool = JaCoCo. Use XML Jacoco reports for SonarQube analysis. Default: false.
    #sqMavenPluginVersionChoice: 'latest' # 'latest' | 'pom'. Required when sqAnalysisEnabled = true. SonarQube scanner for Maven version. Default: latest.
    #checkStyleRunAnalysis: false # boolean. Alias: checkstyleAnalysisEnabled. Run Checkstyle. Default: false.
    #pmdRunAnalysis: false # boolean. Alias: pmdAnalysisEnabled. Run PMD. Default: false.
    #findBugsRunAnalysis: false # boolean. Alias: findbugsAnalysisEnabled. Run FindBugs. Default: false.

入力

Maven POM ファイルを mavenPOMFile - する
string. 必須。 既定値: pom.xml.

リポジトリ ルートから Maven POM ファイルへの相対パスを指定します。

goals - 目標
string. 既定値: package.

options - オプションの
string.

Azure Pipelinesへの発行の publishJUnitResults -
boolean. 既定値: true.

Maven ビルドによって生成された JUnit テスト結果を Azure Pipelines に発行するオプションを指定します。 Test Results Files に一致する各テスト結果ファイルは、Azure Pipelines でテスト実行として発行されます。

testResultsFiles - テスト結果ファイル
string. publishJUnitResults = trueする場合に必要です。 既定値: **/TEST-*.xml.

発行するテスト結果ファイルのパスとパターンを指定します。 ワイルドカードを使用することができます。 ファイル マッチング パターン について詳しくは、以下をご覧ください。
たとえば、名前が TEST-で始まるすべての XML ファイルを **/TEST-*.xml します。
ルート パスが指定されていない場合、ファイルは既定の作業ディレクトリの下で照合され、その値は変数 $(System.DefaultWorkingDirectory)で使用できます。 たとえば、**/TEST-*.xml の値を指定すると、実際には $(System.DefaultWorkingDirectory)/**/TEST-*.xmlからのファイルが一致します。

testRunTitle - テストの実行タイトル
string. 任意 publishJUnitResults = trueするときに使用します。

テスト実行の名前を指定します。

allowBrokenSymlinks - 壊れたシンボリック リンクの を許可する
入力エイリアス: allowBrokenSymbolicLinks。 boolean. 任意 publishJUnitResults = trueするときに使用します。 既定値: true.

falseに設定すると、テスト結果の発行中にタスクが壊れたシンボリック リンクを見つけたときにビルドが失敗します。

codeCoverageToolOption - コード カバレッジ ツールの
入力エイリアス: codeCoverageTool。 string. 使用できる値: None、Cobertura、JaCoCo。 既定値: None.

コード カバレッジ ツールを指定します。

codeCoverageClassFilter - クラスの包含/除外フィルターの
入力エイリアス: classFilter。 string. 任意 codeCoverageTool != Noneするときに使用します。

コード カバレッジの収集に含める、またはクラスから除外するフィルターのコンマ区切りのリストを指定します。 たとえば、+:com.*,+:org.*,-:my.app*.* のようにします。

codeCoverageClassFilesDirectories - クラス ファイルディレクトリ
入力エイリアス: classFilesDirectories。 string. 任意 codeCoverageTool = JaCoCoするときに使用します。

このフィールドは、マルチモジュール プロジェクトに必要です。
Maven POM ファイルからクラス ファイルとアーカイブ ファイル (JAR、WAR など) を含むディレクトリへの相対パスのコンマ区切りの一覧を指定します。 これらのディレクトリ内のクラス ファイルのコード カバレッジが報告されます。 たとえば、target/classes,target/testClasses のようにします。

ソース ファイル ディレクトリを codeCoverageSourceDirectories - する
入力エイリアス: srcDirectories。 string. 任意 codeCoverageTool = JaCoCoするときに使用します。

このフィールドは、マルチモジュール プロジェクトに必要です。
Maven POM ファイルからソース コード ディレクトリへの相対パスのコンマ区切りの一覧を指定します。 コード カバレッジ レポートでは、これらを使用してソース コードが強調表示されます。 たとえば、src/java,src/Test のようにします。

codeCoverageFailIfEmpty - コード カバレッジの結果が見つからない場合に失敗
入力エイリアス: failIfCoverageEmpty。 boolean. 任意 codeCoverageTool != Noneするときに使用します。 既定値: false.

コード カバレッジで発行する結果が生成されなかった場合、ビルドが失敗します。

codeCoverageRestoreOriginalPomXml - タスクの実行後に元の pom.xml を復元
入力エイリアス: restoreOriginalPomXml。 boolean. 任意 codeCoverageTool != Noneするときに使用します。 既定値: false.

コード カバレッジは、結果を生成するために pom.xml を変更します。 元の pom.xmlを保持する必要がある場合は、このオプションを使用します。

javaHomeOption - でJAVA_HOMEを設定する
入力エイリアス: javaHomeSelection。 string. 必須。 使用できる値: JDKVersion (JDK バージョン)、Path。 既定値: JDKVersion.

ビルド中に検出される JDK バージョンを選択するか、JDK パスを手動で入力して、JAVA_HOME を設定します。

JDK バージョンの を する
入力エイリアス: jdkVersion。 string. 任意 javaHomeSelection = JDKVersionするときに使用します。 使用できる値: default、1.21 (JDK 21)、1.17 (JDK 17)、1.11 (JDK 11)、1.10 (JDK 10 (サポート対象外))、1.9 (JDK 9 (サポート対象外))、1.8 (JDK 8)、1.7 (JDK 7)、1.6 (JDK 6 (サポート対象外))。 既定値: default.

選択した JDK バージョンへのパスの検出を試み、それに応じて JAVA_HOME を設定します。

JDK パスを jdkDirectory - する
入力エイリアス: jdkUserInputPath。 string. javaHomeSelection = Pathする場合に必要です。

指定したパスに JAVA_HOME を設定します。

jdkArchitectureOption - JDK アーキテクチャの
入力エイリアス: jdkArchitecture。 string. 任意 jdkVersion != defaultするときに使用します。 使用できる値: x86、x64。 既定値: x64.

JDK のアーキテクチャ (x86、x64) を提供します。

Maven バージョンのを mavenVersionOption - する
入力エイリアス: mavenVersionSelection。 string. 必須。 使用できる値: Default、Path (カスタム パス)。 既定値: Default.

既定の Maven バージョンまたは指定したカスタム パス内のバージョンを使用します。

Maven パスを mavenDirectory - する
入力エイリアス: mavenPath。 string. mavenVersionSelection = Pathする場合に必要です。

Maven インストールへのカスタム パスを指定します (例: /usr/share/maven)。

mavenSetM2Home - 変数 M2_HOME設定する
boolean. 任意 mavenVersionSelection = Pathするときに使用します。 既定値: false.

M2_HOME 変数をカスタム Maven インストール パスに設定します。

mavenOptions - MAVEN_OPTS を に設定する
入力エイリアス: mavenOpts。 string. 既定値: -Xmx1024m.

MAVEN_OPTS 環境変数を設定します。これは、JVM を開始するためのコマンド ライン引数を送信するために使用されます。 -Xmx フラグは、JVM で使用可能な最大メモリを指定します。

mavenAuthenticateFeed - Artifacts フィードを使用した認証
入力エイリアス: mavenFeedAuthenticate。 boolean. 既定値: true.

Azure Artifacts フィードを使用して自動的に認証します。 Artifacts フィードが使用されていない場合は、ビルドを高速化するためにこのオプションの選択を解除します。

sonarQube または SonarCloud 分析を実行する sonarQubeRunAnalysis -
入力エイリアス: sqAnalysisEnabled。 boolean. 既定値: false.

このオプションは、Maven タスクのバージョン 1 から、SonarQube と SonarCloud Marketplace 拡張機能 使用するように変更されました。
[目標] フィールドで目標を実行した後、SonarQube または SonarCloud 分析 実行するには、このオプションを有効にします。 インストール またはパッケージ の目標は、最初に実行する必要があります。 この Maven タスクの前に、いずれかの拡張機能からビルド パイプラインに Analysis Configuration 準備タスクを追加する必要もあります。

isJacocoCoverageReportXML - SonarQube 分析 に XML Jacoco レポートを使用する
boolean. 任意 sqAnalysisEnabled = true && codeCoverageTool = JaCoCoするときに使用します。 既定値: false.

SonarQube 分析に XML Jacoco レポートを使用します。 テスト レポート 詳細を確認します。

Maven バージョン用の SonarQube スキャナーを sqMavenPluginVersionChoice - する
string. sqAnalysisEnabled = trueする場合に必要です。 使用できる値: latest (最新リリースを使用)、pom (pom.xmlで宣言されているバージョンを使用します)。 既定値: latest.

使用する SonarQube Maven プラグインのバージョンを指定します。 最新バージョンを使用することも、pom.xmlのバージョンに依存することもできます。

checkstyleを実行する checkStyleRunAnalysis -
入力エイリアス: checkstyleAnalysisEnabled。 boolean. 既定値: false.

既定の Sun チェックを使用して Checkstyle ツールを実行します。 結果はビルド成果物としてアップロードされます。

pmdRunAnalysis - PMD を実行する
入力エイリアス: pmdAnalysisEnabled。 boolean. 既定値: false.

PMD 静的分析ツールを使用して、コード内のバグを検索します。 結果はビルド成果物としてアップロードされます。

FindBugsを実行する findBugsRunAnalysis -
入力エイリアス: findbugsAnalysisEnabled。 boolean. 既定値: false.

FindBugs 静的分析ツールを使用して、コード内のバグを検索します。 結果はビルド成果物としてアップロードされます。

タスク コントロールのオプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。

出力変数

なし。

注釈

SonarQube 分析の構成は、SonarQube またはタスクの SonarCloud 拡張機能 に移動 分析構成を準備します。

必要条件

要件	説明
パイプラインの種類	YAML、クラシック ビルド、クラシック リリース
実行日	エージェント、DeploymentGroup
の需要	セルフホステッド エージェントには、このタスクを使用するジョブを実行するために 次の 要求に一致する 機能が必要です。
機能の	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	どれでも
設定可能な変数	どれでも
エージェントのバージョン	1.89.0 以上
タスク カテゴリ	建築する

こちらもご覧ください

• Maven の認証 の
• Azure Pipelines で Maven の成果物を発行する
• Java ツール インストーラーの
• Java アプリのビルド