Summary

Creates file or repository labels for a Surround SCM repository.

Assembly

NAnt.Contrib.dll

Namespace

NAnt.Contrib.Tasks.SurroundSCM

Base Types

ExternalProgramBase
SSCMTask

graph BT Type-->Base0["SSCMTask"] click Base0 "/api/NAnt.Contrib.Tasks.SurroundSCM/SSCMTask" Base0-->Base1["ExternalProgramBase"] Type["SSCMLabel"] class Type type-node

Syntax

[TaskName("sscmlabel")]
public class SSCMLabel : SSCMTask

Examples

Label all files under the 'Mainline/Widget' repository recursively in the 'Widget 1.0' branch with 'Release 1.0.1' and the given comment.

<sscmlabel
    serverconnect="localhost:4900"
    serverlogin="administrator:"
    branch="Widget 1.0"
    repository="Mainline/Widget"
    file="readme.txt"
    recursive="true"
    label="Release 1.0.1"
    overwritelabel="false"
    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 no comments.

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

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. An existing 'Release 1.0.1' label on this file to be moved to version 4 of the file.

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

Remarks

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. Existing 'Release 1.0.1' labels on a file will be moved to the tip version of the file.

Attributes

Type	Description
TaskName

Properties

Name	Value	Summary
Branch	string	Surround SCM branch name. The default is pulled from the local working directory.
Comment	string	Comment for the label.
ExeName	string	Override ExeName paramater to sscm.exe for Surround SCM. Inherited from SSCMTask
File	string	File or repository name. Can be / or empty, which means the repository specified by the `NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Repository` attribute or the default repository.
Label	string	The new label to create.
Overwrite	bool	Overwrite the existing label. The default is `false`.
ProgramArguments	string	Gets the command line arguments for the external program. Inherited from SSCMTask
Recursive	bool	Recursively label all files. The default is `false`.
Repository	string	Surround SCM repository path. The default is pulled from the local working directory.
ServerConnect	string	The address and port number of the Surround SCM server host computer. Format is server:port. If not entered, the last saved connection parameters are used. Inherited from SSCMTask
ServerLogin	string	The username and password used to login to the Surround SCM server. Format is username:password. If not entered, the last saved login parameters are used. Inherited from SSCMTask
Version	string	The file version to label. Ignored if a filename is not specified in the `NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.File` attribute.

Methods

Name	Value	Summary
WriteCommandLineArguments(StringBuilder)	void	Writes the task-specific arguments to the specified `System.Text.StringBuilder`.