<sscmfreeze>

[This is preliminary documentation and subject to change.]

Freezes branches in a Surround SCM repository.

Freezing a branch prevents any code changes being made to files in the branch. When a branch is frozen, it is locked and no changes can be made to it.

Parameters

AttributeTypeDescriptionRequired
branchstring Surround SCM branch name. True
mainlinestring Surround SCM mainline branch name. The default is pulled from the local working directory. False
failonerrorbool Determines if task failure stops the build, or is just reported. The default is true. False
ifbool If true then the task will be executed; otherwise, skipped. The default is true. False
serverconnectstring 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. False
serverloginstring 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. False
timeoutint The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. False
unlessbool Opposite of if. If false then the task will be executed; otherwise, skipped. The default is false. False
verbosebool Determines whether the task should report detailed build log messages. The default is false. False

Framework-configurable parameters

AttributeTypeDescriptionRequired
useruntimeenginebool Specifies whether the external program should be executed using a runtime engine, if configured. The default is false. False

Nested Elements:

<arg>

The command-line arguments for the external program.

Contains a collection of Argument elements.

</arg>

Examples

Requirements

Assembly: NAnt.Contrib.Tasks (0.85.1793.0)