Summary
Task to check in files to StarTeam repositories.
- Assembly
- NAnt
.Contrib .dll - Namespace
- NAnt
.Contrib .Tasks .StarTeam - Base Types
-
- Core
.Task - StarTeamTask
- TreeBasedTask
- Core
graph BT
Type-->Base0["TreeBasedTask"]
click Base0 "/api/NAnt.Contrib.Tasks.StarTeam/TreeBasedTask"
Base0-->Base1["StarTeamTask"]
click Base1 "/api/NAnt.Contrib.Tasks.StarTeam/StarTeamTask"
Base1-->Base2["Core.Task"]
Type["StarTeamCheckin"]
class Type type-node
Syntax
[TaskName("stcheckin")]
public class StarTeamCheckin : TreeBasedTaskExamples
Recursively checks in all files in the project.
<!--
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" />
<stcheckin forced="true" rootstarteamfolder="/" recursive="true" url="${ST.url}" />Remarks
You add files to the repository that are not controlled by setting NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.adduncontrolled.
This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stcheckin
You need to have the StarTeam SDK installed for this task to function correctly.
Attributes
| Type | Description |
|---|---|
| TaskName |
Constructors
| Name | Summary |
|---|---|
| StarTeamCheckin |
Fields
| Name | Constant Value | Summary |
|---|---|---|
| _exclude |
Inherited from TreeBasedTask
|
|
| _excludePatterns |
Inherited from TreeBasedTask
|
|
| _filesAffected |
Inherited from TreeBasedTask
|
|
| _forced |
Inherited from TreeBasedTask
|
|
| _include |
Inherited from TreeBasedTask
|
|
| _includePatterns |
Inherited from TreeBasedTask
|
|
| _label |
Inherited from TreeBasedTask
|
|
| _recursive |
Inherited from TreeBasedTask
|
|
| _rootLocalFolder |
Inherited from TreeBasedTask
|
|
| _rootStarTeamFolder |
Inherited from TreeBasedTask
|
|
| _server |
Inherited from StarTeamTask
|
Properties
| Name | Value | Summary |
|---|---|---|
| adduncontrolled | bool |
if true, any files or folders NOT in StarTeam will be added to the repository. Defaults to "false".
|
| comment | string | |
| Excludes | string |
Accepts comma de-limited list of expressions to exclude from tree operations.
If nothing is specified. NO filespecs are excluded.
Inherited from TreeBasedTask
|
| Forced | bool |
Default : false - force check in/out actions regardless of the status that StarTeam is maintaining for the file.
Inherited from TreeBasedTask
|
| Includes | string |
Accepts comma de-limited list of expressions to include in tree operations.
If nothing is set ALL filespecs are included.
Inherited from TreeBasedTask
|
| Label | string |
Label used for checkout. If no label is set latest state of repository is checked out.
Inherited from TreeBasedTask
|
| 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
|
| recursive | bool |
Default : true - should tasks recurse through tree.
Inherited from TreeBasedTask
|
| RootLocalFolder | string |
Root Local folder where files are to be checkout/in or manipulated. Defaults to the StarTeam default folder.
Inherited from TreeBasedTask
|
| rootstarteamfolder | string |
Root StarTeam folder to begin operations on. Defaults to the root of the view.
Inherited from TreeBasedTask
|
| servername | string |
Name of StarTeamServer.
Inherited from StarTeamTask
|
| serverport | string |
Port number of the StarTeam connection.
Inherited from StarTeamTask
|
| unlocked | bool |
Set to do an unlocked checkout; optional, default is false;
If true, file will be unlocked so that other users may change it. If false, lock status will not change.
|
| 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 |
|---|---|---|
| delistLocalFile |
void |
Removes file being worked with from the
NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.listLocalFiles(System.IO.FileInfo) generated hashtable.
Inherited from TreeBasedTask
|
| ExecuteTask |
void |
Does the work of opening the supplied Starteam view and calling
the
NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.visit(StarTeam.StFolder,System.IO.FileInfo) method setting the pattern in motion to perform the task.
Inherited from TreeBasedTask
|
| getLabelID |
IStLabel |
Helper method calls on the StarTeam API to retrieve an ID number for the specified view, corresponding to this.label.
Inherited from TreeBasedTask
|
| IsIncluded |
bool |
Evaluates defined
NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Includes and NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Excludes patterns against a filename.
Inherited from TreeBasedTask
|
| listLocalFiles |
Hashtable |
Gets the collection of the local file names in the supplied directory.
We need to check this collection against what we find in Starteam to
understand what we need to do in order to synch with the repository.
Inherited from TreeBasedTask
static
|
| populatePatterns |
void |
Convert path patterns to regularexpression patterns. Stored in the given string collection.
Inherited from TreeBasedTask
|
| testPreconditions |
void |
Implements base-class abstract function to define tests for any preconditons required by the task
|
| visit |
void |
Implements base-class abstract function to perform the checkin operation on the files in each folder of the tree.
|