Build: Ant

VSTS | TFS 2017 | TFS 2015

Build with Apache Ant

Demands

The build agent must have the following capability:

  • Apache Ant

Arguments

Argument Description
Ant Build File

Relative path from the repository root to the Ant build file.

For more information about build files, see Using Apache Ant.

Options

Options that you want to pass to the Ant command line.

You can provide your own properties (for example, -DmyProperty=myPropertyValue) and also use built-in variables (for example, -DcollectionId=$(system.collectionId)). Alternatively, the built-in variables are already set as environment variables during the build and can be passed directly (for example, -DcollectionIdAsEnvVar=%SYSTEM_COLLECTIONID%).

See Running Apache Ant.

Target(s)

Target(s) for Ant to execute for this build.

See Using Apache Ant Targets.

JUnit Test Results
Publish to VSTS/TFS Select this option to publish JUnit test results produced by the Ant build to VSTS or your on-premises Team Foundation Server. Each test result file that matches Test Results Files is published as a test run.
Test Results Files Test results files path. Wildcards can be used. For example, **/TEST-*.xml for all xml files whose name starts with TEST-."
Test Run Title Assign a title for the JUnit test case results for this build.
Code Coverage
Code Coverage Tool

Select the code coverage tool you want to use.

If you are using the hosted agents, then the tools are set up for you. If you are using on-premises Windows agent, then if you select:

  • JaCoCo, make sure jacocoant.jar is available in lib folder of Ant installation. See JaCoCo.
  • Cobertura, set up an environment variable COBERTURA_HOME pointing to the Cobertura .jar files location. See Cobertura.

After you select one of these tools, the following arguments appear.

Class Files Directories

Specify a comma-separated list of relative paths from the Ant build file to the directories that contain your .class files, archive files (such as .jar and .war). Code coverage is reported for class files present in the directories. Directories and archives are searched recursively for class files. For example: target/classes,target/testClasses.

Class Inclusion/Exclusion Filters

Specify a comma-separated list of filters to include or exclude classes from collecting code coverage. For example: +:com.,+:org.,-:my.app.

Source Files Directories

Specify a comma-separated list of relative paths from the Ant build file to your source directories. Code coverage reports will use these paths to highlight source code. For example: src/java,src/Test.

Advanced
Set ANT_HOME Path If set, overrides any existing ANT_HOME environment variable with the given path.
Set JAVA_HOME by JDK Version Choose which JDK level will be used to run Ant. Will attempt to find JDK version and assign JAVA_HOME before running Ant.
Set JAVA_HOME by Path Directory on build agent where the JDK is located.
JDK Architecture Optionally supply the architecture (x86, x64) of the JDK.
Control options

Q&A

Do I need an agent?

You need at least one agent to run your build or release. Get an agent.

I can't select a default agent queue and I can't queue my build or release. How do I fix this?

See queues.

I use Team Foundation Server on-premises and I don't see some of these features. Why not?

Some of these features are available only on VSTS and not yet available on-premises. Some features are available on-premises if you have upgraded to the latest version of TFS.