Ant@1 - Ant v1 工作

使用此工作搭配 Apache Ant 進行建置。

Syntax

# 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 - 確定 Ant 安裝的 lib 資料夾中有jacocoant.jar可用。 深入瞭解 JaCoCo Ant 工作。
• Cobertura - 確定環境變數COBERTURA_HOME指向 Cobertura .jar檔案位置。 深入瞭解 Cobertura 與 Ant 工作。

選取其中一個工具之後，會出現下列自變數：

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。 允許的值： default、 (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。

jdkUserInputDirectory - JDK 路徑
輸入別名： jdkUserInputPath。 string. 當 javaHomeSelection = Path 時為必要。

將JAVA_HOME設定為指定的路徑。

jdkArchitectureOption - JDK 架構
輸入別名： jdkArchitecture。 string. 選擇性。 使用時機 jdkVersion != default。 允許值：x86 和 x64。 預設值：x64。

選擇性地提供 JDK (x86、x64) 架構。

工作控制選項

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

輸出變數

無。

備註

使用此工作搭配 Apache Ant 進行建置。

規格需求

需求	描述
管線類型	YAML、傳統組建、傳統版本
執行於	Agent、DeploymentGroup
要求	自我裝載代理程式必須具備符合下列需求的功能，才能執行使用此工作的作業：ant
Capabilities	此工作不符合作業中後續工作的任何需求。
命令限制	任何
Settable 變數	任何
代理程式版本	1.89.0 或更新版本
工作類別	建置