Ant@1 - Ant v1 タスク

このタスクを使用して Apache Ant を使用してビルドします。

構文

# Ant v1
# Build with Apache Ant.
- task: Ant@1
  inputs:
    buildFile: 'build.xml' # string. Alias: antBuildFile. Required. Ant build file. Default: build.xml.
    #options: # string. Options. 
    #targets: # string. Target(s). 
  # 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. 
  # Code Coverage
    #codeCoverageToolOptions: 'None' # 'None' | 'Cobertura' | 'JaCoCo'. Alias: codeCoverageTool. Code coverage tool. Default: None.
    codeCoverageClassFilesDirectories: '.' # string. Alias: classFilesDirectories. Required when codeCoverageTool != None. Class files directories. Default: ..
    #codeCoverageClassFilter: # string. Alias: classFilter. Optional. Use when codeCoverageTool != None. Class inclusion/exclusion filters. 
    #codeCoverageSourceDirectories: # string. Alias: srcDirectories. Optional. Use when codeCoverageTool != None. Source files directories. 
    #codeCoverageFailIfEmpty: false # boolean. Alias: failIfCoverageEmpty. Optional. Use when codeCoverageTool != None. Fail when code coverage results are missing. Default: false.
  # Advanced
    #antHomeDirectory: # string. Alias: antHomeUserInputPath. Set ANT_HOME path. 
    javaHomeOption: 'JDKVersion' # 'JDKVersion' | 'Path'. Alias: javaHomeSelection. Required. Set JAVA_HOME by. Default: JDKVersion.
    #jdkVersionOption: 'default' # 'default' | '1.11' | '1.10' | '1.9' | '1.8' | '1.7' | '1.6'. Alias: jdkVersion. Optional. Use when javaHomeSelection = JDKVersion. JDK version. Default: default.
    #jdkUserInputDirectory: # string. Alias: jdkUserInputPath. Required when javaHomeSelection = Path. JDK path. 
    #jdkArchitectureOption: 'x64' # 'x86' | 'x64'. Alias: jdkArchitecture. Optional. Use when jdkVersion != default. JDK architecture. Default: x64.

入力

buildFile - Ant ビルド ファイル
入力エイリアス: antBuildFile。 string. 必須です。 既定値: build.xml。

リポジトリ ルートから Ant ビルド ファイルへの相対パス。

ビルド ファイルの詳細については、「 Apache Ant の使用」を参照してください。

options - オプション
string.

Ant コマンド ラインに渡すオプションを提供します。 独自のプロパティ (例: ) を指定し、 -DmyProperty=myPropertyValue組み込みの変数 (例: -DcollectionId=$(system.collectionId)) を使用することもできます。 または、組み込み変数はビルド中に環境変数として既に設定されており、直接渡すことができます (例: -DcollectionIdAsEnvVar=%SYSTEM_COLLECTIONID%)。

Apache Ant の実行に関するページを参照してください。

targets - ターゲット
string.

ビルドするターゲットのスペース区切りリスト (省略可能)。 指定しない場合は、ターゲットが default 使用されます。 ターゲットが定義されていない default 場合、Ant 1.6.0 以降はすべての最上位タスクをビルドします。

Apache Ant ターゲットの使用に関するページを参照してください。

publishJUnitResults - Azure Pipelines に発行する
boolean. 既定値: true。

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

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

テスト結果ファイルのパス。 ワイルドカードを使用できます。 詳細については、 ファイル 一致パターンのリファレンスを参照してください。 たとえば、名前が TEST- で始まるすべての xml ファイルの場合は **/TEST-*.xml を使用します。

testRunTitle - テスト実行のタイトル
string. 省略可能。 の場合は publishJUnitResults = trueを使用します。

テスト実行の名前を提供します。

codeCoverageToolOptions - コード カバレッジ ツール
入力エイリアス: codeCoverageTool。 string. 許可値: None、Cobertura、JaCoCo。 既定値: None。

コード カバレッジ ツールを選択します。

Microsoft でホストされるエージェントを使用している場合は、ツールが設定されます。 オンプレミスの Windows エージェントを使用している場合は、エージェントが JaCoco または Cobertura に対して設定されていることを確認する必要があります。

• JaCoCo - jacocoant.jarが Ant インストールの lib フォルダーで使用できることを確認します。 JaCoCo Ant タスクの詳細を確認してください。
• Cobertura - 環境変数COBERTURA_HOMEが Cobertura .jar ファイルの場所を指していることを確認します。 Ant タスクを使用した Cobertura の詳細については、こちらを参照してください。

これらのツールのいずれかを選択すると、次の引数が表示されます。

codeCoverageClassFilesDirectories - クラス ファイルディレクトリ
入力エイリアス: classFilesDirectories。 string. codeCoverageTool != None の場合に必要です。 既定値: .。

Ant ビルド ファイルからクラス ファイルとアーカイブ ファイル (.jar、 .warなど) を含むディレクトリへの相対パスのコンマ区切りの一覧。 これらのディレクトリのクラス ファイルのコード カバレッジが報告されます。 (例: target/classes,target/testClasses)。

codeCoverageClassFilter - クラス包含/除外フィルター
入力エイリアス: classFilter。 string. 省略可能。 の場合は codeCoverageTool != Noneを使用します。

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

codeCoverageSourceDirectories - ソース ファイルのディレクトリ
入力エイリアス: srcDirectories。 string. 省略可能。 の場合は codeCoverageTool != Noneを使用します。

Ant ビルド ファイルからソース コード ディレクトリへの相対パスのコンマ区切りの一覧。 コード カバレッジ レポートでは、これらを使用してソース コードが強調表示されます。 (例: src/java,src/Test)。

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

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

antHomeDirectory - パスANT_HOME設定する
入力エイリアス: antHomeUserInputPath。 string.

が設定されている場合は、既存のANT_HOME環境変数を指定されたパスでオーバーライドします。

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

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

jdkVersionOption - JDK バージョン
入力エイリアス: jdkVersion。 string. 省略可能。 の場合は javaHomeSelection = JDKVersionを使用します。 使用できる値は、 default1.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を設定します。

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

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

jdkArchitectureOption - JDK アーキテクチャ
入力エイリアス: jdkArchitecture。 string. 省略可能。 の場合は jdkVersion != defaultを使用します。 使用できる値: x86、x64。 既定値: x64。

必要に応じて、JDK のアーキテクチャ (x86、x64) を提供します。

タスク制御オプション

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

出力変数

[なし] :

解説

このタスクを使用して Apache Ant を使用してビルドします。

要件

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