Plug-in Documentation
Ant
Overview
The Ant plug-in is an automation plug-in. You can use the Ant plug-in during deployment to automate Ant tasks that are defined in a build.xml file.
Compatibility
This plug-in requires IBM UrbanCode Build version 6.1 or later.
The steps in this plug-in run on all supported platforms.
Installation
No special steps are required for installation. See Installing plug-ins in UrbanCode Build.
History
Version 7
This version includes translated steps and properties.
Version 6
The JVM Properties field was removed.
Steps
Process steps in the Ant plug-in
Ant
Run an Ant script.
Name | Type | Description | Required |
---|---|---|---|
ANT_HOME | String | The path to the Ant installation to use to run the Ant script. By default, the path is the ANT_HOME environment variable on the agent. | Yes |
ANT_OPTS | String | Ant-specific arguments, which are used in the ANT_OPTS environment variable. Enter each argument on a new line. For example: -Xmx1024m or -XX:MaxPermSize=512m | No |
Ant Properties | String | Ant-specific arguments, such as -v for verbose output. Enter each argument on a new line. | No |
Ant Script File | String | The name of the Ant script file. | Yes |
JAVA_HOME | String | The path to the Java installation to use to run Ant. By default, the path is the JAVA_HOME environment variable on the agent. | Yes |
Properties | String | Properties to pass to Ant. These properties are available by name in the Ant script. Enter each argument on a new line in the following format: name=value | No |
Script Content | String | Optional: Specify the content of the Ant script. The content is written to the file specified by the Ant Script File field, and then run. | No |
Targets | String | The names of the targets to run in the Ant script file. If blank, the default target is used. | No |