requestTeamBuild
The requestTeamBuild task requests a build by using a specified build definition. There must be an active engine that supports the build definition in order for the request to succeed.
The following table contains requestTeamBuild task attributes.
Attribute | Description | Required |
---|---|---|
buildDefinitionId |
For the requestTeamBuild task, the identifier of the build definition to use. |
Yes |
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 |
userId |
User ID for authentication to the repository. Requires password or passwordFile to be set. |
Yes |
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 |
allowDuplicateRequests |
Enable or disable duplicate requests. The default is true. |
No |
deletePropertiesFile |
Path to a properties file. This properties file specifies properties that should be omitted when the build is run. The properties are assumed to exist in the build definition. The path can be a relative path from the base directory of the build file or a full path. |
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 |
overridePropertiesFile |
Path to a properties file. This properties file can add new properties or override existing properties in the build definition. The path can be a relative path from the base directory of the build file or a full path. |
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 |
personalBuild |
Allow requesting a personal build. The default is false. |
No |
requestUUIDProperty |
Stores the UUID of the retrieved build request. It is set only if a request is found. |
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 |
resultUUIDProperty |
Property to store the UUID of the build result. |
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
<requestTeamBuild repositoryAddress="${repositoryAddress}"
userId="${userId}"
password="${password}"
buildDefinitionId="${buildDefinitionId}" />