Summary

Task for supporting labeling of repositories with incremented version numbers. The version number calculated will be concatenated to the NAnt.Contrib.Tasks.StarTeam.LabelTask.Label.

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["StarTeamAutoLabel"] class Type type-node

Syntax

[TaskName("stautolabel")]
public class StarTeamAutoLabel : LabelTask

Examples

Increment the build version.

<stautolabel url="${ST.url}" />

Set the major version.

<stautolabel majorversion="2" url="${ST.url}" />

Increment the minor version.

<stautolabel incrementminor="true" url="${ST.url}" />

Example versionnumber.xml file.

    <?xml version="1.0"?>
<stautolabel>
    <version major="1" minor="0" build="0" />
</stautolabel>

Remarks

Instruments root of repository with versionnumber.xml file.

If this file is not present, it is created and checked into StarTeam. The default version number is 1.0.0. By default the build number is incremented. Properties are present to allow setting and incrementing of major, minor, and build versions.

When label is created, properties are set to expose version information and the new label :

label
Version.text
Version.major
Version.minor
Version.build

Incrementing or setting major or minor versions does NOT reset the build version.

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
BuildVersion	int	Build version number used for label. If this value is set. `NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementBuild` is ignored.
Description	string	Optional description of the label to be stored in the StarTeam project. Inherited from LabelTask
IncrementBuild	bool	Increment build version number. The default is `true`. If `NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.BuildVersion` is set, this property is ignored.
IncrementMajor	bool	Increment major version number. The default is `false`. If `NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MajorVersion` is set, this property is ignored.
IncrementMinor	bool	Increment minor version number. The default is `false`. If `NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MinorVersion` is set, this property is ignored.
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
MajorVersion	int	Major version number used for label. If this value is set, `NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMajor` is ignored.
MinorVersion	int	Minor version number used for label. If this value is set, `NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMinor` is ignored.
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
VersionFile	string	Allows user to specify the filename where the version xml is stored. The default is `versionnumber.xml`.
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	Looks for versionnumber.xml at root of repository. Updates the xml in this file to correspond with properties set by user and checks in changes. A label is then created based on properties set.

StarTeamAutoLabel Class