generateChangeLog

The generateChangeLog task compares two snapshots to generate a list of change sets, added components, and removed components. You can use the logPublisher task to publish the change log file to a specific build result.

The generateChangeLog task compares a current snapshot with an earlier snapshot. The task can retrieve an earlier snapshot attribute if an attribute is not provided when the current snapshot is published to a build result as an extended contribution. The task searches for an earlier snapshot contribution that is attached to the most recent build result that meets the following criteria:

  • Is not the current build result
  • Was built from the same build definition as the current build result
  • Was started before the current build result
  • Is not a personal build

The following table contains descriptions of each generateChangeLog task attribute.

Note: You can only specify one current snapshot attribute: currentSnapshotUUID, currentSnapshotName, or currentBuildResultUUID. You can only specify one earlier snapshot attribute: beforeSnapshotUUID, beforeSnapshotName, or beforeBuildResultUUID.
Attribute Description Required

changeLogFile

The file that the generated change log is written to.

Yes

currentSnapshotUUID

The UUID of the snapshot that is used to create the change log. This attribute is more specific than currentSnapshotName or currentBuildResultUUID because it identifies an exact snapshot. Multiple snapshots can have the same name. The build result UUIDs are only useful if the associated build result has a snapshot contribution.

Yes

currentSnapshotName

The name of the snapshot that is used to create the change log.

Yes

currentBuildResultUUID

The UUID of a build result with a snapshot contribution that is used to create the change log. If no snapshot contribution is attached to this build result, the change log is not created.

Yes

beforeSnapshotUUID

The UUID of the snapshot that is used to create the change log. This attribute is more specific than beforeSnapshotName or beforeBuildResultUUID because it identifies an exact snapshot. Multiple snapshots can have the same name. The build result UUIDs are only useful if the associated build result has a snapshot contribution.

Yes

beforeSnapshotName

The name of the snapshot that is used to create the change log.

Yes

beforeBuildResultUUID

The UUID of a build result with a snapshot contribution that is used to create the change log.

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

showFileChanges

If true, the change log displays file level changes. The default is false.

No

showVersionIdentifiers

If true, the change log displays known file version identifiers. If true, the showFileChanges attribute must also be set to true. The default is false. This attribute is only for the generateChangeLog task.

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

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

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

The following example illustrates how to get changes between two snapshots, identified by name:

<generateChangeLog currentSnapshotName="build_20100809-1620" 
                      beforeSnapshotName="build_20100809-1545"
                      showFileChanges="true"
                      changeLogFile="${changeLogDir}\buildChanges2.txt" 
                      repositoryAddress="${repositoryAddress}"
                      userId="${userId}"
                      password="${password}"
                      verbose="true" />

The following example illustrates how to get changes in a particular build. The buildResultUUID and repositoryAddress properties are set by Jazz Build Engine.

<generateChangeLog currentBuildResultUUID="${buildResultUUID}"	
                      repositoryAddress="${repositoryAddress}"
                      showFileChanges="true"
                      changeLogFile="${changeLogDir}\buildChanges1.txt"
                      userId="${userId}"
                      password="${password}"
                      verbose="true" />
		

Changes between the current build and a previous snapshot, identified by name.

<generateChangeLog currentBuildResultUUID="${buildResultUUID}" 
                      beforeSnapshotName="build_20100809-1545"
                      showFileChanges="true"	
                      changeLogFile="${changeLogDir}\buildChanges3.txt"
                      repositoryAddress="${repositoryAddress}"
                      userId="${userId}"
                      password="${password}"
                      verbose="true" />

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