Summary

Allows creation of view labels in StarTeam repositories.

Assembly

NAnt.Contrib.dll

Namespace

NAnt.Contrib.Tasks.StarTeam

Base Types

graph BT Type-->Base0["LabelTask"] click Base0 "/api/NAnt.Contrib.Tasks.StarTeam/LabelTask" Base0-->Base1["StarTeamTask"] click Base1 "/api/NAnt.Contrib.Tasks.StarTeam/StarTeamTask" Base1-->Base2["Core.Task"] Type["StarTeamLabel"] class Type type-node

Syntax

[TaskName("stlabel")]
public class StarTeamLabel : LabelTask

Examples

Creates a label in a StarTeam repository.

    <!-- 
  constructs a 'url' containing connection information to pass to the task 
  alternatively you can set each attribute manually 
-->
<property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
<stlabel label="3.1 (label title goes here)" description="This is a label description" url="${ST.url}" />

Remarks

Often when building projects you wish to label the source control repository.

By default this task creates view labels with the build option turned on.

This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel

You need to have the StarTeam SDK installed for this task to function correctly.

Attributes

Type	Description
TaskName

Fields

Name	Constant Value	Summary
_description		The label description to be set in Starteam. Inherited from LabelTask
_isAsOfDateSet		Kludgy flag to keep track if date has been set. Please kill this if you can. Here based on experiences I have had with VB.NET Inherited from LabelTask
_isBuildLabel		Is the label being created a build label. Inherited from LabelTask
_isRevision		Does user wish to make a revision label? Inherited from LabelTask
_labelAsOfDate		If set the datetime to set the label as of. Inherited from LabelTask
_labelName		The name of the label to be set in Starteam. Inherited from LabelTask
_server		Inherited from StarTeamTask

Properties

Name	Value	Summary
BuildLabel	bool	Should label be marked build : default is true Inherited from LabelTask
Description	string	Optional description of the label to be stored in the StarTeam project. Inherited from LabelTask
Label	string	The name to be given to the label; required. Inherited from LabelTask
LastBuild	string	Optional: If this property is set the label will be created as of the datetime specified. Please provide a datetime format that can be parsed via `System.DateTime.Parse(System.String,System.IFormatProvider)`. Inherited from LabelTask
password	string	The password used for login. Inherited from StarTeamTask
projectname	string	The name of the StarTeam project to be acted on Inherited from StarTeamTask
RevisionLabel	bool	Should label created be a revision label. The default is `false`. Inherited from LabelTask
servername	string	Name of StarTeamServer. Inherited from StarTeamTask
serverport	string	Port number of the StarTeam connection. Inherited from StarTeamTask
url	string	One stop to set all parameters needed to connect to a StarTeam server. Inherited from StarTeamTask
username	string	The StarTeam user name used for login. Inherited from StarTeamTask
viewname	string	The name of the StarTeam view to be acted on. Inherited from StarTeamTask

Methods

Name	Value	Summary
createLabel(StView)	StLabel	Inherited from LabelTask
ExecuteTask()	void	This method does the work of creating the new view and checking it into Starteam.

StarTeamLabel Class