startTeamBuild

The startTeamBuild task runs a standalone Engineering Workflow Management Build without using the Jazz Build Engine. It can be used to run a build from an existing build request. The lifecycle of this build then will be controlled directly by the script. All properties in the build definition are automatically defined in Ant after executing this task.
Note: If you use startTeamBuild to start a build from a new build request, the build is immediately abandoned. To start a build from a new build request, use requestTeamBuild.

The following table contains 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 for authentication to the repository. Requires password or passwordFile to be set.

Yes

autoComplete

For the startTeamBuild task, specifies that the build process terminates and related build activities complete 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.
Note: When this attribute is false, the build process can complete, but related build activities remain open. Another process can reuse the build result and run build activities to complete a build.

No

buildDefinitionId

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

Note: Either buildDefinitionId or requestUUID must be given, but not both.

certificateFile

The path to the file that contains the user's login certificate for authentication. Requires password or passwordFile to be set. You can specify certificateFile or repositoriesFile, but not both.

No

engineId

For the startTeamBuild task, the id of the engine that will be marked as performing the build. The lifecycle of the build is still controlled by the script, so the engine will not actually run the build, but the build engine is required for a build result. Cannot be specified if requestUUID is used; otherwise it's required.

No

Note: Only allowed if buildDefinitionId is provided.

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

The label for the build result contribution.

No

integratedWindows

Whether to use Integrated Windows Authentication

No

kerberos

Whether to use Windows user credentials using Kerberos/SPNeGO.

No

password

Password for the user ID for authentication to the repository. Either password or passwordFile can be provided, but not both.

No

passwordFile

The password file to use for authentication to 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. Either password or passwordFile can be provided, but not both.

No

repositoriesFile

The repositories registry file containing a listing of repositories and their login credentials. You can specify repositoriesFile or certificateFile, but not both. If you specify repositoriesFile, do not specify either password or passwordFile. The repositories file is created and updated through the use of scm login and logout commands.

No

requestUUID

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

Note: Either buildDefinitionId or requestUUID must be given, but not both.

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

reuseLoginOption

The first time an Ant task logs in to a repository, a connection is not terminated at the end of this task. All subsequent tasks reuse this connection as long as they connect to same repository with same user ID. When a task logs in to a different repository or with a different user ID, the previous connection is terminated and a new connection is created and reused.

No

smartCard

Whether to use the connected smart card for authentication (true or false). Requires userId to be set. For more information about smart card authentication, see Connecting to repositories and project areas.

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}" />

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki