The task deletes a filtered list of SCM snapshots associated with the specified build that are owned by the build’s workspace. These snapshots - SCM BaselineSet items - are created when a build is requested that is configured with Jazz Source Control when the "Accept latest changes before loading" option is enabled which creates the snapshot. The task searches for the Jazz Source Control configuration element in the build definition, retrieves the pointer to the build’s workspace from the configuration element, retrieves all snapshots owned by the build workspace and applies the specified filtering criteria to derive the list of snapshots to be deleted.

Attributes

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

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

Snapshot Filtering Elements

The includeSnapshot and excludeSnapshot elements are specified within the element. Each includeSnapshot element identifies filters for build snapshots to include; the build snapshots to delete. Each excludeSnapshot element identifies filters for build snapshots to exclude; the build snapshots to keep. If no includeSnapshot elements are specified, no build snapshots will be deleted. No error is raised if includeSnapshot elements find no eligible build snapshots, or if, excludeSnapshot elements skip all build snapshots.

The attributes specified for filtering on includeSnapshot and excludeSnapshot elements are AND’ed. For example, if you specify buildSnapshot="true" and createTime="2d" on an includeSnapshot element, all snapshots for the specified build that that are 2 or more days old will be deleted.

If multiple includeSnapshot or excludeSnapshot elements are specified, they are OR’ed. If a build result qualifies for any includeSnapshot, it will be deleted. If a build result qualifies for any excludeSnapshot, it will not be deleted.

The following table describes the valid includeSnapshot/excludeSnapshot attribute values:

Notes

• The userId specified to the task must have the authority to delete the build snapshots owned by the build workspace. This can be accomplished by specifying the owner of the build workspace via the userId attribute.
• If you run the DeleteAllBuildSnapshots Ant script example below, you may see residual build snapshots. Most likely these will be snapshots associated with the build prior to a build definition rename. These snapshots may be deleted by rerunning the DeleteAllBuildSnapshots script with the buildSnapshot attribute set to false.
• The task does not find or delete orphaned build snapshots, snapshots associated with a deleted build definition or build workspace. These can be deleted manually by running a search for Snapshots, specifying a “*” for the snapshot name, and selecting the orphaned snapshots for deletion.
• If a limit attribute is specified, each group of snapshots, bounded by the specified limit, are sorted in ascending creation date order. In other words, each group of snapshots is sorted is in ascending order, but creation date order is not maintained between groups. When a keep attribute is also specified, the latest snapshots are still kept. If a kept

Examples

Delete all build snapshots for the specified build ID that are at least 365 days old:

<?xml version="1.0" encoding="UTF-8"?>
<!--
    Licensed Materials - Property of IBM
    (c) Copyright IBM Corporation 2024. 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 name="Delete Snapshots" default="all" xmlns:xt="antlib:com.ibm.team.build.extensions.toolkit">
    <description>Delete Snapshots</description>
    
    <loadproperties srcFile="${user.home}${file.separator}tvt6012.9702.properties"/>
    
    <target name="main" description="main">
        <xt:deleteBuildSnapshots
            repositoryAddress="${repositoryAddress}"
            userId="${userId}"
            password="${password}"
            buildId="Setup 702 dependency build">
            <xt:includeSnapshot buildSnapshot="true" createTime="365d"/>
        </xt:deleteBuildSnapshots>
    </target>
    
    <target depends="main" description="all" name="all"/>
</project>
    

Delete all build snapshots for all z/OS Dependency builds defined to all process areas defined on the EWM server:

<?xml version="1.0" encoding="UTF-8"?>
<!--
    Licensed Materials - Property of IBM
    (c) Copyright IBM Corporation 2024. 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
    name="DeleteAllBuildSnapshots"
    default="all"
    xmlns:ac="antlib:net.sf.antcontrib"
    xmlns:xt="antlib:com.ibm.team.build.extensions.toolkit">
    <description>Delete All Build Snapshots</description>
    
    <loadproperties srcFile="${user.home}${file.separator}tvt6012.9702.properties"/>
    
    <target name="main" description="main">
        
        <!-- Get process areas -->
        <xt:getProcessAreas
            repositoryAddress="${repositoryAddress}"
            userId="${userId}"
            password="${password}"
            property="pas"
        />
        
        <!-- Process process areas -->
        <ac:for list="${pas}" param="pa" delimiter=";" trim="true">
            <sequential>
                <echo>Starting process: @{pa}</echo>
                
                <!-- Get dependency builds -->
                <xt:getBuildDefinitions
                    repositoryAddress="${repositoryAddress}"
                    userId="${userId}"
                    password="${password}"
                    processAreaName="@{pa}"
                    property="ids"
                    templateId="z/OS Dependency Build - Rational Build Agent"
                />
                
                <!-- Process builds by ID -->
                <ac:for list="${ids}" param="id" delimiter=";" trim="true">
                    <sequential>
                        <echo>Starting build: @{id}</echo>
                        
                        <xt:deleteBuildSnapshots
                            repositoryAddress="${repositoryAddress}"
                            userId="${userId}"
                            password="${password}"
                            buildId="@{id}"
                            preview="false">
                            <xt:includeSnapshot buildSnapshot="true"/>
                        </xt:deleteBuildSnapshots>
                        
                        <echo>Complete build: @{id}</echo>
                    </sequential>
                </ac:for>
                
                <echo>Complete process: @{pa}</echo>
            </sequential>
        </ac:for>
        
    </target>
    
    <target depends="main" description="all" name="all"/>
</project>