VersionOne CruiseControl Integration
The VersionOne CruiseControl.NET integration creates a record of CruiseControl 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 VersionOne Publisher has been installed, team members include a story or defect ID, such as “S-01454”, in the comments of their SCM
commit . Every time a build executes the publisher creates a BuildRun asset in VersionOne with details of the build. If the build comment contains
story or defect IDs, the publisher will also create or reuse change-sets assets in VersionOne and assoicates the build with the appropriate
story or defect.
Using this integration you can better answer the following questions:
VersionOne: 8.1 or above
Integration Server:
Continous Integration Server:
These installation instructions assume that CruiseControl.NET is already installed, configured, and working properly.
Verify that you can connect to your VersionOne instance from the machine hosting CruiseControl.NET
Download VersionOne publisher 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 CruiseControl.NET configuration.
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 CruiseControl.NET
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 an entry in the grid for the build you forced. If not, verify your configuration.
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
CruiseControl.NET Configuration
This section describes how to configure CruiseControl.NET for use with VersionOne
Copy the following files from the downloaded package into your CruiseControl server directory
ccnet.VersionOnePublisher.plugin.dll
VersionOne.SDK.APIClient.dll
VersionOne.SDK.ObjectModel.dll
The other dlls are provided as reference only and should not be copied or moved.
Add the VersionOne publisher to the list of publishers for the appropriate project in your CruiseControl.NET configuration file (ccnet.config)
<publishers>
<xmllogger />
<versionone url="http://V1Host/VersionOne/" username="admin" password="admin" webroot="http://CCHost/ccnet" referenceexpression="[A-Z]{1,2}-[0-9]+" referencefield="Number"/>
</publishers>
Use the following table to configure the VersionOne Publisher
Table 1.
| Node | Description | Type | Required | Default |
|---|
| url | The URL of the VersionOne Application. For example: http://server/VersionOne/ | String | True | |
| username | The username to authenticate with. This field is optional if using NT Auth (integrated auth). Required when using VersionOne authentication. | String | (varies) | |
| password | The password to authenticate with. This field is optional if using NT Auth (integrated auth). Required when using VersionOne authentication. | String | (varies) | |
| integratedauth | True to use NT Auth (integrated auth), false to use VersionOne authentication. | Boolean | (varies) | false |
| webroot | The root of the URL used for linking to build logs. For example: http://localhost/ccnet/ | String | False | Null |
| server | The "BuildServer" portion of the URL used for linking to build logs. For example: http://localhost/ccnet/server/{BuildServer}/project/... | String | False | "local" |
| referenceexpression | The regular expression to use when matching primary workitems (stories and defects) with change comments. Required when using changeset integration. | String | (varies) | Null |
| referencefield | The system name of an attribute to search when matching primary workitems (stories and defects) with change comments. Required when using changeset integration. | String | (varies) | Nulll |
Here's an explanation of the VersionOne publisher illustrated above:
Table 2.
| The VersionOne URL is | http://V1Host/VersionOne/ |
| The CruiseControl.NET URL is | http://CCHost/ccnet |
| The publisher will login into VersionOne as | admin |
| When searching CruiseControl.NET comments to determine if it contains a VersionOne Workitem, the publisher will use the regular expression | "[A-Z]{1,2}-[0-9]+” |
| If a Workitem identifier is found, the publisher will attempt to match this information to the VersionOne Workitem attribute | Number |
Copyright © 2008, VersionOne, Inc. All rights reserved. This document was generated 2008-07-15 11:02:33.