Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 58 Next »

Summary

This plugin integrates Microsoft Team Foundation Server source control (also known as TFVC) to Jenkins.

Plugin Information

View Team Foundation Server on the plugin site for more information.

With this plugin you can use a workspace that will create a work folder in the Jenkins 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 Jenkins 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.

Configuration

Requirements

The plugin [currently] requires a TFS command line tool to be installed on the build agents that will be retrieving source code from TFS.

  1. Install either Microsoft Visual Studio or Microsoft Team Explorer Everywhere Command-Line Client (CLC) on the build agents
  2. Add tf.exe (Visual Studio) OR one of tf.cmd or tf (TEE CLC) to the PATH of the build agents' user(s).

Job configuration

Server URL

The URL to the Team Foundation Server. Example: https://tfs02.codeplex.com

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.

Build environment variables

The plugin will set the following environment variables for the build, after a checkout:

  • 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.
  • TFS_CHANGESET - The change set number that is checked out in the workspace

FAQ

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 codeplex.com.
  • 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.

That's all you need to start retrieving files from your project at codeplex.com.

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 JENKINS-4184 and JENKINS-4021). 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 -Duser.country=US on the command line or check the documentation for the container that Hudson is running within.

Plugin version information

Change log

Upcoming

  • Mostly bug fixes

3.1.1 (Feb 25 2014)

3.0.1 (Oct 25 2013)

  • Fixes UnsatisfiedLinkError when path to plugin contains spaces. Thanks to Jesse Jacob for reporting and helping diagnose the problem. (pull request #18)

3.0.0 (Oct 23 2013)

  • Now using the TFS SDK for Java to obtain richer information about committers/culprits. (pull request #17)
  • If you get an UnsatisfiedLinkError, either:
    • Please upgrade to 3.0.1 at your earliest convenience
    • Work around the defect by defining the com.microsoft.tfs.jni.native.base-directory property to point to the tfs plugin's native folder.
      For example, add the following to the /service/arguments element of jenkins.xml, before the -jar argument:
      "-Dcom.microsoft.tfs.jni.native.base-directory=C:\Program Files (x86)\Jenkins\plugins\tfs\WEB-INF\lib\native"

2.0 (Sep 4 2013)

1.20 (Sep 17 2011)

1.19 (Sep 05 2011)

  • Fixed the problem of getting the change set number from the checked out workspace. (JENKINS-10900)

1.18 (Sep 01 2011)

  • Fixed so german output from the tfs tool can be parsed properly. (JENKINS-10784)
  • Added new env variable containing the TFS change set number TFS_CHANGESET. mzagar contributed the fix. (JENKINS-6078)

1.17 (Mar 10 2011)

  • Reverted the fix that changed the way how URLs to TSWA was built. (JENKINS-7394)

1.16 (Mar 7 2011)

  • Fixed so a build no longer throws a NullPointerException when the node that it was previous built on was deleted. (JENKINS-8322)
  • Updated the TFS Web Access URLs so they work with TFS 2008. (JENKINS-7394)

1.12 (Jan 4 2011)

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

1.11 (Feb 1 2010)

1.10 (Dec 30 2009)

  • Changed user and domain name regex to be more lenient than only accepting lower case characters. (JENKINS-4600)
  • Updated code for more recent Hudson

1.9 (Aug 31 2009)

  • Updated TFS SCM to conform with changes in base SCM class. This fixes the NPE when polling a server. (JENKINS-4325)

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. (JENKINS-2208)
  • Fixed a problem when TF command line tool outputed dates containing p.m. which is not recognized by the default date parsers. (JENKINS-4184)
  • 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 (JENKINS-3778)
  • 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. (JENKINS-3784)

1.6

  • Updated regular expression to avoid StackOverFlowError while parsing long changesets history data (JENKINS-3683)
  • Added TFS_PROJECTPATH, TFS_SERVERURL, TFS_USERNAME to the environment variable list (JENKINS-3784)

1.5

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

1.4

  • Fixed a problem with interfacing with the tf tool on linux (JENKINS-2241)
  • Fixed a problem with name casing in a resource folder (JENKINS-2229)
  • Fixed a problem with workspace names containing a space (JENKINS-2264)
  • Fixed a problem if the workspace already existed on another computer it was deleted at the end of the checkout (JENKINS-2268)
  • Added the macro ${NODE_NAME} that can be used in a workspace name
  • Added very basic support for the opentf client (JENKINS-2277)
  • Fixed so the workspace name and work folder path are available as build environmental variables (JENKINS-2266)
  • 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) (JENKINS-2302)

1.3

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

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.

1.1

  • Quick release for supporting older Hudsons than 1.234

1.0

  • Initial version supporting Microsoft and Teamprise command line clients.
  • No labels