VersionOne Integration with Microsoft Team Foundation Server
VersionOne's integration with Microsoft Team Foundation Server (V1TFS) provides your organization with visibility into change while freeing the development team to focus on deliverables. This integration is comprised of two parts: The TFS Listener and the VersionOne Check-in Policy.
The TFS Listener is responsible for responding to check-in and build events from TFS. For each qualifying check-in event the listener creates a "ChangeSet" in VersionOne, providing the team visibility into the code changes for a story or defect. This visibility can be useful when tracking down defects or performing code reviews. For each qualifying build event, the listener creates a "BuildRun" in VersionOne. If possible BuildRuns are associated with stories and/or defect in VersionOne , providing the organization visibility into build contents. This visibility is useful when selecting a build to release, identifying problem builds, or generating release notes.
In order for the Listener to create associations in VersionOne, the check-in comment must include a VersionOne story or defect ID, such as "S-01454". The VersionOne Check-in Policy ensures that this requirement is met. When this policy is enabled for a TFS project, each comments is scanned for a VersionOne ID. If not found, the Policy fails and prompts the user to select an ID from a dialog box. The user may select from items they own in active iterations, or from all items in active iterations.
Before you can use the VersionOne VSTS integration you must perform the following actions
The VersionOne TFS Listener is a WebService that must be installed on a machine that has access to your VersionOne Server and your Team Foundation Server. To avoid network delays it's better if you collocate the Listener with one of the other servers. It is recommended that you install the Listener on the Team Foundation Server.
To install the TFS Listener, execute "VersionOne TFS Listener.msi" on the appropriate machine and follow the steps in the installation wizard.
Top
Configure the TFS Listener
In order for the TFS Listener to work it must know which VersionOne instance to use when creating assets and making associations and which TFS instance to use for listening to events. Configuring the TFS Listener is accomplished using the TFS Listener Configuration utility. This utility is installed, and launched, as part of the TFS Listener installation. If you need to reconfigure the TFS Listener at a later date, this utility is available from the Start menu under Programs | VersionOne TFS Listener.
The utility has 3 tabs
-
The "VersionOne Server" tab allows you to to configure VersionOne connectivity. This configuration is required.
-
The "TFS Server" tab allows you to subscribe to TFS Events. This configuration is required.
-
The "Advanced" tab allows you to configure the regular expression used to match VersionOne IDs in Check-in comments. This configuration is optional since we set the default value to a working expression. We do not recommend you change this unless necessary.
Top
Install the VersionOne CheckI-in Policy
The VersionOne Check-in Policy ensures that each TFS Check-in contains a VersionOne identifier. This policy must be installed on each machine running Visual Studio There are two installers for the VersionOne Check-in policy, select the appropriate installer based on the version of Visual Studio. As with Visual Studio both versions of the policy can coexist on a single machine.
To install the VersionOne TFS Policy, run the appropriate setup msi for the version of Visual Studio being used.
Table 1.
| Visual Studio |
Installer |
| 2005 |
VersionOne TFS Policy.msi |
| 2008 |
VersionOne TFS Policy 2008.msi |
Top
Enable the Policy for a TFS Project
In order to be considered when performing a check-in, the VersionOne TFS Check-in policy must be enabled on a TFS project. Perform the following steps to enable the Check-in policy on a TFS Project
-
Open Visual Studio
-
Open the Team Explorer
-
Right click on the desired project
-
Select "Team Project Settings"
-
Select "Source Control..."
-
Select the "Check-in Policy" tab
-
Click "Add"
-
Select the "VersionOne Policy"
-
Click Ok to close the "Add Check-in Policy" dialog
-
Click Ok to close the "Source Control Settings" dialog
Top
Configure VersionOne Build Integration
In order to access TFS Build Runs in VersionOne you must configure the VersionOne application. The following steps describe how to enable build integration, create a build project, and assign that project to a project containing stories and defects.
-
Log into the VersionOne application as admin
-
Navigate to the Admin | Configuration | System page.
-
Check the “Enable Build Integration” checkbox and click the Apply button.
-
Navigate to the Admin | Projects | Build Project page
-
Click Add to add a new Build Project
-
Specify the following
-
Name – this is how the Build Project will be known to VersionOne users
-
Reference – this is the Build Project is known to the partner system
-
Click Ok to save the new Build Project
-
Navigate to the Admin | Projects | Projects page
-
Click Edit on the row for the project you want associated with a Build Project
-
Using the “Build Projects” dropdown add the appropriate Build Project.
-
Click Ok to accept the changes
-
Logout
Top
Perform the following steps to verify the integration:
-
Open a Visual Studio project that is in the selected TFS project
-
Open a file and make a change (for instance, add a comment)
-
Save the change
-
Check-in the change
-
Type a comment, but do not provide a VersionOne identifier
-
Click "Check In"
You should be presented with the following dialog
-
Provide the VersionOne URL and your credentials
Note
You may want to wait until after testing to cache credentials
-
Click OK
You should now be presented with the following dialog, populated with information from your VersionOne Server
-
Select an Item in VersionOne
-
Click OK
Once the check-in completes, launch your browser and navigate to VersionOne. Login and locate the item you chose to associate with the check-in. Open this item and click in the Relationship tab. You should now see data in the following grids: Changesets, Last Affected Build Runs, and Affected Build Runs. The following screen-shot is an example:
Top
If you do not see any ChangeSet or Build relationships
Verify that Changesets and Build Integration are both enabled in VersionOne
Ensure you selected the same VersionOne Story or Defect in Visual Studio and VersionOne
Use the TFS Listener Configuration tool and verify that you are subscribed to TFS Events
Ensure that the following VersionOne URLs point to the same instance
The TFS Listener URL (using the Listener Configuration utility)
The URL used in Visual Studio
The Browser URL
Navigate to the TFS Listener URL, specified in the Listener Configuration Utility, and make sure the WebService is running
Check the application event log on the TFS Listener machine for any TFS errors
If you do not see Build relationships, check the following
Verify that Build Integration is enabled and configured properly in VersionOne
Verify that a build executed when the check-in was performed. If not, or if you only build daily, you will need to force a build
Check the application event log on the TFS Listener machine for any TFS errors
Top
Copyright © 2008, VersionOne, Inc. All rights reserved. This document was generated 2008-08-04 14:32:37.