<sscmcheckin>

[This is preliminary documentation and subject to change.]

Checks in files in Surround SCM repository.

Check in updated Surround SCM files with changes, removes the lock on the files, and makes changes available to other users.

Parameters

AttributeTypeDescriptionRequired
branchstring Surround SCM branch name. The default is pulled from the local working directory. False
commentstring Comment for the check-in. False
deletelocalbool Remove local file after check in. The default is false. False
filestring File or repository name. Can be / or empty, which means the repository specified by the repository option or the default repository. False
forceupdatebool Update version even if no changes. The default is false. False
getlocalbool Get file after check in. The default is true. False
keeplockedbool Keep the lock after check in. The default is false. False
labelstring A label for the check in code. False
overwritelabelbool Overwrite previous label on file. The default is false. False
quietbool Do not list repository and local full path of the Surround SCM server. The default is false. False
recursivebool Recursively check in all files and sub-repositories. The default is false. False
repositorystring Surround SCM repository path. The default is pulled from the local working directory. False
skipautomergebool Force check in without merge. Ignores code changes checked in after the user's last checkout or merge. The default is false. False
ttpdatabasestring The TestTrack Pro database configuration name. False
ttpdefectsstring The TestTrack Pro defect number(s) for attachment. Format is "#:#:#:#". False
ttploginstring The TestTrack Pro username and password. False
writablebool Make file writable after check in. The default is false. 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.

Represents a command-line argument.

Parameters

AttributeTypeDescriptionRequired
filefile The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. False
ifbool Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true. False
linestring List of command-line arguments; will be passed to the executable as is. False
path<path> The value for a PATH-like command-line argument; you can use : or ; as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. False
unlessbool Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false. False
valuestring A single command-line argument; can contain space characters. False

Nested Elements:

<path>

Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used.

</path>

Examples

</arg>

Examples

Requirements

Assembly: NAnt.Contrib.Tasks (0.85.1869.0)