The macro compares two snapshots to generate a list of change sets, added components, and removed components.

Attributes

The macro supports Team Build Attributes, as well as, its own macro specific attributes. Click on a link for more information on the common attributes.

The following table describes the macro specific attributes for the macro:

Macro Specific Attributes
Attribute	Description	Required
beforeBuildResultUUID	The UUID of a build result with a snapshot contribution that is to be used to create the change log.	No
beforeSnapshotName	The name of the snapshot that is to be used to create the change log.	No
beforeSnapshotUUID	The UUID of the snapshot that is to be 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 and a build result is only useful if it has a snapshot contribution.	No
changeLogFilefile	The path to a file where the generated change log is written. The path can be an absolute path or a path relative to the base directory of the build file.	Yes
currentBuildResultUUID	The UUID of a build result with a snapshot contribution that is to be used to create the change log. If no snapshot contribution is attached to this build result, the change log is not created.	No
currentSnapshotName	The name of the snapshot that is used to create the change log.	No
currentSnapshotUUID	The UUID of the snapshot that is to be 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 and a build result is useful if it has a snapshot contribution.	No
property	Name of the property in which to store the generated change log.	Yes
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`.	No

Notes

One before... and one current... snapshot attribute is required.

Examples

Generate a change log from two snapshots using the Common Macros automated login option:

<?xml version="1.0" encoding="UTF-8"?>
<!--
    Licensed Materials - Property of IBM
    (c) Copyright IBM Corporation 2020. All Rights Reserved.
    
    Note to U.S. Government Users Restricted Rights:
    Use, duplication or disclosure restricted by GSA ADP Schedule
    Contract with IBM Corp.
-->
<project
    basedir="."
    default="all"
    name="Example"
    xmlns:xt="antlib:com.ibm.team.build.extensions.toolkit">
    <description>Example</description>
    
    <!-- Load build extensions -->
    <xt:loadBuildExtensions/>
    <xt:getJarLocation property="jarPath"/>
    
    <!-- Load common resources -->
    <import>
        <javaresource name="scripts/smpe/imports/$common.xml">
            <classpath location="${jarPath}"/>
        </javaresource>
    </import>
    
    <!-- - - - - - - - - - - - - - - - - - - *
    *  Example                               *
    *- - - - - - - - - - - - - - - - - - - -->
    <target name="main" description="main">
        
        <GetChangeLog
            beforeSnapshotName="BeforeSnapshot"
            changeLogFile="ChangeLog.txt"
            currentSnapshotName="CurrentSnapshot"
            property="changeLogProperty"
        />
        
    </target>
    
    <target depends="main" description="all" name="all"/>
</project>

getTaskNameHdr()

Attributes

Notes

Examples