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.
# 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/TFS. 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 生成文件
输入别名: antBuildFilestring. 必需。 默认值: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 中发布。


publishJUnitResults - 发布到 Azure Pipelines/TFS
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 - 代码覆盖率工具
输入别名: codeCoverageToolstring. 允许的值:NoneCoberturaJaCoCo。 默认值:None

选择代码覆盖率工具。

如果你使用 Microsoft 托管代理,则会为你设置这些工具。 如果使用本地 Windows 代理,必须确保为 JaCoco 或 Cobertura 设置代理。

  • JaCoCo - 确保在 Ant 安装的 lib 文件夹中提供jacocoant.jar。 详细了解 JaCoCo Ant 任务
  • Cobertura - 确保环境变量COBERTURA_HOME指向 Cobertura .jar 文件位置。 详细了解 Cobertura with Ant tasks

选择其中一个工具后,将显示以下参数:


codeCoverageClassFilesDirectories - 类文件目录
输入别名: classFilesDirectoriesstring. 当 codeCoverageTool != None 时,需要此选项。 默认值:.

从 Ant 生成文件到包含类文件和存档文件的目录的相对路径的逗号分隔列表, (.jar.war等 ) 。 将报告这些目录中类文件的代码覆盖率。 例如:target/classes,target/testClasses


codeCoverageClassFilter - 类包含/排除筛选器
输入别名: classFilterstring. 可选。 在 时 codeCoverageTool != None使用 。

以逗号分隔的筛选器列表,用于包括或排除从收集代码覆盖率的类。 例如:+:com.+:org.-:my.app*.


codeCoverageSourceDirectories - 源文件目录
输入别名: srcDirectoriesstring. 可选。 在 时 codeCoverageTool != None使用 。

从 Ant 生成文件到源代码目录的相对路径的逗号分隔列表。 代码覆盖率报告将使用这些报告来突出显示源代码。 例如:src/java,src/Test


codeCoverageFailIfEmpty - 缺少代码覆盖率结果时失败
输入别名: failIfCoverageEmptyboolean. 可选。 在 时 codeCoverageTool != None使用 。 默认值:false

如果代码覆盖率未生成任何要发布的结果,则生成失败。


antHomeDirectory - 设置ANT_HOME路径
输入别名: antHomeUserInputPathstring.

如果已设置,则使用给定路径替代任何现有的 ANT_HOME 环境变量。


javaHomeOption - 设置JAVA_HOME依据
输入别名: javaHomeSelectionstring. 必需。 允许的值: JDKVersion (JDK 版本) 。 Path 默认值:JDKVersion

通过选择将在生成过程中发现的 JDK 版本或通过手动输入 JDK 路径来设置JAVA_HOME。


jdkVersionOption - JDK 版本
输入别名: jdkVersionstring. 可选。 在 时 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 路径
输入别名: jdkUserInputPathstring. 当 javaHomeSelection = Path 时,需要此选项。

将JAVA_HOME设置为给定路径。


jdkArchitectureOption - JDK 体系结构
输入别名: jdkArchitecturestring. 可选。 在 时 jdkVersion != default使用 。 允许的值:x86x64。 默认值:x64

(可选)提供 JDK (x86、x64) 体系结构。


任务控制选项

除了任务输入,所有任务都有控制选项。 有关详细信息,请参阅 控制选项和常见任务属性

输出变量

无。

备注

使用此任务通过 Apache Ant 进行生成。

要求

要求 说明
管道类型 YAML,经典内部版本,经典版本
运行平台 Agent、DeploymentGroup
需求 自承载代理必须具有满足以下要求的功能才能运行使用此任务的作业:ant
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任意
可设置的变量 任意
代理版本 1.89.0 或更高版本
任务类别 构建