startTeamBuild

The startTeamBuild task starts a Jazz™ Team Build from either an existing or new build request. After this task completes, all properties in the build definition and build engine are automatically defined in Ant.

The table below describes startTeamBuild task attributes.

Attribute Description Required

repositoryAddress

Address of the team repository to use. The value of this attribute is typically ${repositoryAddress} because that property is built-in when using the Jazz Build Engine.

Yes

resultUUIDProperty

Property to store the UUID of the build result.

Yes

userId

User ID to use.

Yes

autoComplete

For the startTeamBuild task, specifies whether the build should be completed automatically. The default is true. When this attribute is true, you must use the parameter -listener com.ibm.team.build.ant.listener.TeamBuildListener when launching Ant.

No

buildDefinitionId

For the startTeamBuild task, the build definition of the build to start. Required if requestUUID is not specified.

No

engineId

For the startTeamBuild task, the identifier of the build engine that runs the build. Required if the requestUUID is not specified.

No

failOnError

If true (the default), the task fails if it encounters an error. If false, some errors are ignored and the task is completed.

No

label

Label to use for the build.

No

password

Password for the user ID, a zero-length string by default unless specified.

No

passwordFile

The password file to use for the connection. You can create a suitable password file by invoking the Jazz Build Engine with the -createPasswordFile argument. You can only specify one password file.

No

requestUUID

Specifies an existing build request to use when starting the build. If specified, the buildDefinitionID and the engineID cannot be specified.

No

resultUUIDFile

File to use to store the build result. The path can be a relative path to the base directory of the build file or a full path. The file is formatted in java.util.Properties format and contains a property with the name specified by the resultUUIDProperty attribute.

No

verbose

Specifies more message output. The default is false.

No

Example

<startTeamBuild repositoryAddress="${repositoryAddress}"
		                userId="${userId}"
		                password="${password}"
		                requestUUID="${requestUUID}"
		                resultUUIDProperty="buildResultUUID"
		                label="test build"
		                autoComplete="false"
		                verbose="true" />

<fail message="Did not start a build as expected."
		      unless="buildResultUUID" />
<echo message="result UUID = ${buildResultUUID}" />

Feedback