Connect the TFS source control server to CloudBees CD/RO for code checkouts, preflight builds, and continuous integration. With this plugin, you can have different configurations, such as the preflight and sentry functions, that would be difficult to implement without it.
TFS must be installed and must be accessible from the command line. If you do not want to include TFS in the PATH variable, you must specify the TFS binary path. |
Plugin Version 2.5.4.2020110201 Revised on May 24, 2019
Integrated version
This plugin was developed and tested against Team Foundation Server Version 2013.
Setting up the plugin configuration
For all parameter descriptions in this document, the required parameters are in bold italics. |
Input
Plugin configurations are sets of parameters that apply across some or all of the plugin procedures. They reduce repetition of common values, create predefined sets of parameters for end users, and store credentials securely. Each configuration has a unique name that is automatically entered in designated parameters in the procedures.
-
Go to
to open the source control configurations page. -
Click Create Configuration to open the New Source Control Configuration page.
-
For the SCM Type parameter, click the down arrow and select TFS.
-
Enter the following information.
You may need to create additional configurations later.
Parameter | Description |
---|---|
Configuration Name |
The name of the SCM configuration. |
Description |
The description of the configuration. CloudBees CD does not use this information. |
Login As |
Username: The user name that CloudBees CD uses to communicate with the TFS server. Password: Provide the password for the Username. Retype Password: Re-enter the password. |
TFS binary path |
Path to TFS binary when it is not included in PATH variable. |
Plugin procedures
CheckoutCode
This procedure downloads (checks out) a copy of the code from the TFS server to the specified machine.
Input
If you specify both the Collection URL and Server Hostname parameters, a warning message appears, and the plugin tries to use the Server Hostname parameter because it also works on Visual Studio 2010.
If you do not specify values for these parameters, nothing is downloaded to the specified machine, and an error message appears.
The procedure upon completion populates a property sheet called ecscm_changelogs
, which contains the changes included in this checkout since the latest.
-
Go to the CheckoutCode procedure.
-
Enter the following parameters:

GetSCMTag
Use this procedure for Continuous Integration. It monitors the repository to discover when something changes and to trigger a preconfigured procedure.
Preflight (Agent Part)
The Preflight procedure runs the agent part of the preflight workflow.
-
Go to the Preflight procedure.
-
Enter the following parameters:

Examples and use cases
Configuring a sentry schedule form
In the project, select the Schedules tab, and then select the SCM type in the pop-up.
-
Select an step name.
-
Then select the procedure that runs when the sentry is triggered.
-
Enter the following information that is passed to the sentry monitor. In this example, the client is being monitored so that every time someone submits a changelist, the sentry triggers the runWithSentry procedure.
If something changes in the client, the sentry monitor shows a status.
The runWithSentry
job now appears in the Jobs tab
Release notes
ECSCM-TFS 2.5.0
-
Option "Run Schedule Even if Another Instance is Running" has been added for Sentry schedules.
ECSCM-TFS 2.4.0
-
Added support to the Checkout code procedure to populate a property sheet called ecscm_changelogs that will contain the changes included in a checkout since the latest.
ECSCM-TFS 2.3.0 (August 13, 2015)
-
Added support for Linux TFS client.
-
Fix job error when undoPendingChanges option is selected and no pending changes are present.
-
Check itemSpec presense if undo pending pages selected.
ECSCM-TFS 2.2.2 (February 10, 2015)
-
This plugin has been tested against Team Foundation Server Version 2013.
ECSCM-TFS 2.0.0
-
Updated the Help page.
-
Added the step picker.
-
Added the XML panels.
-
Added the Help links.