snapshotPublisher
The snapshotPublisher task updates the snapshot associated with a build result in a Jazz® repository.
The following table describes snapshotPublisher task attributes.
Attribute | Description | Required |
---|---|---|
buildResultUUID |
The UUID of the build result to update. The value of this attribute is typically ${buildResultUUID} because the property is built-in when using the Jazz Build Engine. |
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 |
snapshotUUID |
The build snapshot item ID. |
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 |
componentName |
The name of the component to which this contribution applies. Used for grouping in the user interface. |
No |
createPasswordFile |
Creates a password file. |
No |
customIteration |
The Ant attribute for specifying a custom iteration that will be associated to the build snapshot. This is expected to take the following form: parentTimeline/parentIteration1/parentIteration2/customIteration. The timeline and iteration segments are the identifier (which is unique) and not the display name. The timeline is also expected to be from the same project area that contains the build definition. If we are not specifying a custom iteration Ant property, then the behavior is that we will navigate from the build result to the build definition, then the owning process area, and select the current iteration. The iteration that is associated to the build snapshot is made visible in the history graph for a component. For more information, see Viewing component history graphically. |
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 |
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 |
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
<snapshotPublisher repositoryAddress="${repositoryAddress}"
userId="${userId}"
password="${password}"
buildResultUUID="${buildResultUUID}"
snapshotUUID="${snapshotUUID}" />