VersionOne TeamCity Integration

Table of Contents

Description

The VersionOne TeamCity Notifier creates a record of TeamCity builds in VersionOne, so the development teams can associate stories and defects to a particular build. This visibility is useful when identifying problem builds or generating release notes.

Once the TeamCity Notifier has been installed, team members include a VersionOne identifier , such as “S-01454” or "TK-01234", in the comments of their SCM commit . Every time a build executes the Notifier creates a BuildRun asset in VersionOne with details of the build. If the build comment contains VersionOne Story or Defect Identifiers, the Notifier will create or reuse a VersionOne change-set and relate the build with the appropriate Story or Defect.

Using this integration you can better address the following situations:

For Defects
- Which build the defect was reported against
- Which build contained the fix for the defect
- Which builds contain work for the defect
For Stories (Backlog Item)
- Which builds contain work for the story
- Which build contained the completed story
For Build Runs
- Which defects were fixed
- Which stories were completed
- Which defects were introduced
- When work for a story or defect was included
- Which Change-sets were included
For a range of Build Runs
- Which stories were completed
- Which defects were fixed
- Which defects were introduced

System Requirements

VersionOne: 8.1 or above

Integration Server:

Operating System—Windows 2000, 2003

Continous Integration Server:

Tested with TeamCity Version 4.0. Note: If you are using TeamCity 4.5 you need release 4.5.4 or better.

Downloads

The latest version of V1TeamCity is available at V1: Integration Downloads.

Installation

These installation instructions assume that TeamCity is already installed, configured, and working properly.

1. Ensure Connectivity

Verify that you can connect to your VersionOne instance from the machine hosting TeamCity

2. Extract Files

Download the TeamCity integration using the link above and extract it into a folder of your choice. This can be a temporary location since we will copy some of these files during TeamCity configuration.

3. Configure

Configuration for Build Integration is a 2 step process.

4. Verify the integration

Once configuration is complete use the following steps to verify that the build integration is working

Navigate to TeamCity
Force a build on the project you configured
Wait for build to complete
Navigate to VersionOne
Login
Select VersionOne project in 'My Projects' dropdown
Navigate to the Reports | Reports Overview page
Select the "Build Run Quicklist" Report

You should see an entry in the grid for the build you forced. If not, verify your configuration.

Configuration

VersionOne Configuration

Log into the VersionOne application as 'admin' or any user with System Admin as their Default Role
Navigate to the Admin | Configuration | System page.
Check the “Enable Build Integration” checkbox and click the Apply button.

Figure 1.
Navigate to the Admin | Projects | Build Project page

Figure 2.
Click Add to add a new Build Project
Specify the following
1. Name – this is how the Build Project will be known to VersionOne users
2. Reference – this is how the Build Project is known to TeamCity.
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.

Figure 3.
Click OK to accept the changes
Logout

TeamCity Configuration

This section describes how to configure TeamCity for use with VersionOne

On your TeamCity server, copy the downloaded package into your TeamCity Data directory. You can determine this directory by viewing the Server Configuration page.

Figure 4.
Restart the TeamCity application server for the changes to take effect
Open a browser and navigate to your TeamCity URL
Login as a TeamCity Administrator
Navigate to the "Administration" page
Click the "Edit server configuration" link
Locate the "VersionOne Integration Settings" and click on the "Edit settings" link

Configure the integration setting based on the following table

Table 1.

Parameter	Description	Type	Required	Default
Server URL	The URL of the VersionOne Application. For example: http://server/VersionOne/	String	True	http://localhost/VersionOne/
Username	The VersionOne member name used to connect to Server URL.	String	True	admin
Password	The password for the specified member	String	True
Reference Field	The system name of an attribute to search when matching primary workitems (stories and defects) with change comments.	String	True	Number
Comment RegEx	The regular expression to use when matching primary workitems (stories and defects) with change comments.	String	True	[A-Z]{1,2}-[0-9]+
Use fully qualified build names	Determines how the integration looks for Build Projects in VersionOne. If False (not checked), the integration uses only the TeamCity Project name. If True (checked), the integration uses the TeamCity Project name and build configuration name. The format for this string is {Project} :: {Configuration}	Boolean	True	False

Click "Test Connection" to verify that you can connect to VersionOne.

Note

If this fails, verifty that you can access the URL from the TeamCity server and that the username and password are correct.
Click "Save"

Here's an example configuration

Figure 5.

Downloads

VersionOne TeamCity Integration

Description

System Requirements

Downloads

Installation

1. Ensure Connectivity

2. Extract Files

3. Configure

4. Verify the integration

Configuration

VersionOne Configuration

TeamCity Configuration

Note