SSCMLabel Task
Surround SCM Label task for creating labels on files or repositories.
Apache Ant
 
Description

Labels provide a way to mark a specific version of a file or repository. You can create labels for single files, multiple files, or all files in a repository. When you create a label, a new entry is created in the history. The file, and the version number, do not change.

<taskdef name="sscmlabel" classname="com.seapine.surroundscm.ant.SSCMLabel" />

 
Parameters
Attribute Description Type Requirement
file Enter a file or repository name. Can be / or empty, which means the repository specified by the repository option or the default repository. String Required
label Enter the new label. String
branch Enter the branch name. The default branch is set in the working directory. String Optional
comment Enter a comment. String
recursive Recursively label all files. boolean
repository Enter the full parent repository path. String
failOnError Set to true if you want the task to throw a BuildException when it fails. boolean
serverconnect Enter the address and port number of the Surround SCM server host computer. If not entered, use the last saved connection parameters. String
serverlogin Enter the username and password used to login to the Surround SCM server. If not entered, use the last saved login parameters. String
version Enter the version number of a file. Ignored if you do not specify one specific file in the File attribute. String
 
Parameters as nested elements
 
Examples
 <sscmlabel
   serverconnect="localhost:4900"
   serverlogin="administrator:"
   branch="Widget 1.0"
   repository="Mainline/Widget"
   file="/"
   recursive="true"
   label="Release 1.0.1"
   overwrite="true"
   comment="This labels the final build for the release of Widget 1.0.1."
   />

Label all files under the 'Mainline/Widget' repository recursively in the 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. OverwriteLabel=false means that an existing 'Release 1.0.1' labels on a file will be moved to the tip version of the file.

 <sscmlabel
   serverconnect="localhost:4900"
   serverlogin="administrator:"
   branch="Widget 1.0"
   repository="Mainline/Widget"
   file="/"
   recursive="true"
   label="Release 1.0.1"
   />

Label all files under the 'Mainline/Widget' repository recursively in the 'Widget 1.0' branch with 'Release 1.0.1' and no comments. OverwriteLabel=false (or not there at all) means that an existing 'Release 1.0.1' labels on a file will not be moved to the tip version of the file.

 <sscmlabel
   serverconnect="localhost:4900"
   serverlogin="administrator:"
   branch="Widget 1.0"
   repository="Mainline/Widget"
   file="Widget.java"
   label="Release 1.0.1"
   overwrite="true"
   comment="This labels the final build for the release of Widget 1.0.1."
   version="4"
   />

Label version 4 of the file 'Mainline/Widget/Widget.java' in the 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. OverwriteLabel=true forces an existing 'Release 1.0.1' label on this file to be moved to version 4 of the file.


Copyright © 2000-2003, Apache Software Foundation