View Source

h1. Summary
{excerpt}This plugin integrates [Microsoft Team Foundation Server|] source control to Hudson.{excerpt}

{warning:title=No longer maintained in the Hudson community}
This plugin has moved it's development to the Jenkins infrastructure, which can be found at [the new Jenkins Wiki page|]. Please report issues and find the latest versions in the Jenkins community.

With this plugin you can use a workspace that will create a work folder in the Hudson workspace. At the moment, this plugin supports:
* Retrieving read-only copies of files and folders from a Team Foundation Server.
* Polling a Team Foundation Server to automatically start builds when there are changes.
* Links from the Hudson change sets to Team Server Web Access. _(Also known as a repository browser)_

The workspace will automatically create a workspace on the Team Foundation Server and map a work folder (in the Hudson workspace) to it.

h1. Configuration

h2. System configuration

!tfs-system-config.png|align=center, vspace=2!

# Open the system configuration page "Manage Hudson->Configure system"
# Enter the path to the TF command line client, that should be used by Hudson

h2. Job configuration

!tfs-job-config.png|align=center, vspace=2!

| {{Server URL}} | The URL to the Team Foundation Server. Example: {{}} |
| {{Project path}} | The project and path to retrieve from the server. The project path must start with {{$/}}, and contain any sub path that exists in the project repository. Example: {{$/project/trunk/src}}. |
| {{User name}} | The user name to use when connecting to the server. The user name must contain the domain and user name. The user name must be formatted either as {{domain\username}} or {{username@domain}}. |
| {{Password}} | The user password. |
| {{Use update}} | If this option is checked, then the workspace and work folder will not be removed at the end of build. This makes the build faster, but artifacts remain between builds. If it is not checked, the plugin will create a workspace and map it to a local folder at the start of the build, and then delete the workspace at the end of the build. |
| {{Local work folder}} | The name of the local work folder. The specified folder will contain the files retrieved from the repository. Default is {{.}}, ie the files will be downloaded into the Hudson workspace folder. |
| {{Workspace name}} | The name of the workspace that Hudson should use when creating and deleting workspaces on the server. The workspace name supports three macros; {{$\{JOB_NAME\}}} is replaced by the job name, {{$\{USER_NAME\}}} is replaced by the user name Hudson is running as and {{$\{NODE_NAME\}}} is replaced by the name of the node. Default workspace name is {{Hudson-$\{JOB_NAME\}}}. |
| {{Repository browser}} | If the Team Foundation Server has any web access to the files, this can be configured here. By adding a repository browser, the plugin will create links in the Changes page to the repository browser. Currently the plugin supports Team System Web Access. |

h2. Build environment variable

* *TFS_WORKSPACE* - The name of the workspace.
* *TFS_WORKFOLDER* - The full path to the working folder.
* *TFS_PROJECTPATH* - The project path that is mapped to the workspace.
* *TFS_SERVERURL* - The URL to the Team Foundation Server.
* *TFS_USERNAME* - The user name that is used to connect to the Team Foundation Server.

h1. Requirements

The plugin requires that one of the below command line tools is installed on the master and slave machines.

h2. Microsoft TF CCL

The [Visual Studio Team System 2008 Team Explorer|] is a free tool to access Team Foundation Servers. The {{TF.exe}} tool is installed into the Visual Studio folder that may be located at {{c:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\TF.exe}}

h2. Teamprise TF CCL

The [Teamprise Command-Line Client|] can be used on most platforms that support java.

h2. opentf

[opentf|] is an open source implementation of the TF executable, that can be used on platforms that support mono.

h5. Current limitations
Because of [issue 9|] it is not possible to use the _"Use update"_ feature. The workspace has to be created and removed in each build, which unfortunately makes checking out code a lot slower.

Because of [issue 7|] is it not possible to get a list of changes for a build.

h1. FAQ

h3. How should I set up the plugin for my CodePlex project?

* Find out the TFS server for your project, which is displayed in the source code page for your project at
* The user name must be suffixed with {{_cp}} and the domain is {{snd}}. If your user name is redsolo, then enter "{{snd\redsolo_cp}}" as the user name in the plugin configuration.
* Note that the user must be a member of the project to be able to create a workspace on the Team foundation server.

Thats all you need to start retrieving files from your project at

h3. The plugin is having problems parsing the dates that TF outputs, what can I do?

The TF command line outputs date according to the locale and Microsofts own specification. Sometimes the outputed date can not be parsed by any of the default locale dependent parsers that the JDK includes (_for some more details, see [4184@issue] and [4021@issue]_). This will throw an exception in the change set parsing and fail the build.

To fix this, do the following:
* Change the locale by Windows Regional Settings to United States and English on the server and all hudson nodes. After that tf.exe should output dates in english, which can be parsed properly.
* Start Hudson using the UnitedStates, English locale. Either set it using {{-Duser.language=en}} on the command line or check the documentation for the container that Hudson is running within.

h1. Plugin version information

h2. Road map

h3. 1.x
* Add tagging support

h2. Change log

h3. _Upcoming_

h3. 1.12 (Jan 4 2011)

* Fixed so changes that was committed after the workspace was updated is not included into the change log. ([6596@issue])
* Fixed so the date is parsed using the correct keyword. ([6454@issue])
* Updated plugin so it works with the TEE command line tool. ([6870@issue])
* Added support for change sets that has been checked in by a user not responsible for the change. _(ie /Author checkins)_ [4943@issue])

h3. 1.11 (Feb 1 2010)

* Fixed a problem when the server with the workspaces contained a dash. ([4666@issue], [4726@issue])

h3. 1.10 (Dec 30 2009)

* Changed user and domain name regex to be more lenient than only accepting lower case characters. ([4600@issue])
* Updated code for more recent Hudson

h3. 1.9 (Aug 31 2009)

* Updated TFS SCM to conform with changes in base SCM class. This fixes the NPE when polling a server. ([4325@issue])

h3. 1.8

* Fixed so when a workspace is removed or wiped on a node, or when the project is deleted or renamed, the TFS workspace will be deleted. ([2208@issue])
* Fixed a problem when TF command line tool outputed dates containing {{p.m.}} which is not recognized by the default date parsers. ([4184@issue])
* The TFS workspace is no longer removed during a build, instead it is removed at the begning of the next build if the _Use update_ flag is not set ([3778@issue])
* If workspace name, project path or local folder is changed in the configuration; the next build will remove the TFS workspace and create a new one with the new configuration. ([3784@issue])

h3. 1.6

* Updated regular expression to avoid StackOverFlowError while parsing long changesets history data ([3683@issue])
* Added TFS_PROJECTPATH, TFS_SERVERURL, TFS_USERNAME to the environment variable list ([3784@issue])

h3. 1.5

* Fixed a problem with diff links for the Team System Web Access repository browser ([3780@issue])
* Fixed a problem when comments contained forbidden XML chars (such as &, <, >, etc), which would throw an exception when trying to load the change log. ([2229@issue])

h3. 1.4

* Fixed a problem with interfacing with the tf tool on linux ([2241@issue])
* Fixed a problem with name casing in a resource folder ([2229@issue])
* Fixed a problem with workspace names containing a space ([2264@issue])
* Fixed a problem if the workspace already existed on another computer it was deleted at the end of the checkout ([2268@issue])
* Added the macro {{$\{NODE_NAME\}}} that can be used in a workspace name
* Added very basic support for the opentf client ([2277@issue])
* Fixed so the workspace name and work folder path are available as build environmental variables ([2266@issue])
* Fixed so the build is not failed if the TF tool returns a exit code for _partial success_ (exit code=1)
* Fixed so invalid characters in the workspace name are replaced with {{\_}}
* Added support for paramterized builds (server url, project path and workspace name can contain build parameters) ([2302@issue])

h3. 1.3

* Improved support for Team System Web Access; added links to file content and diffs to previous version.

h3. 1.2

* Added support for Team System Web Access repository browser. Now the Changes page has links to TSWA.
* Fixed a bug where the work folder was not cleaned between builds if the job is not using the update feature.

h3. 1.1
* Quick release for supporting older Hudsons than 1.234

h3. 1.0
* Initial version supporting Microsoft and Teamprise command line clients.