Welcome to CodeBeamer2SVN

CodeBeamer2SVN (CB2SVN) builds upon CodeBeamer functionality, providing an improved link between CodeBeamer tracker items and Subversion commits.

This User Guide is intended to give an overview of the product and help anyone using the CB2SVN Client. For installation, configuration and troubleshooting, please refer to the Administration Guide.

A CB2SVN system is arranged as shown in the diagram below. Typically, as a Subversion user, you will only be concerned with the client part of the system. Your Administrator will have configured various options for you (you can find out about all of the possible options in the Administration guide).

CB2SVN Overview

Using CB2SVN

Everyday Use

There are 2 user ids that are significant, the id you use with Subversion and your CodeBeamer user id. Both of these need to be set in your cb2svn.cfg client config file.

Normally, your system administrator will have configured your system to run the CB2SVN Client on login. If this is the case, then you should be ready to start using CB2SVN!

All you have to do is use Subversion as you normally do (you can use any Subversion client). However, once CB2SVN is enabled, you'll see a pop-up window on your machine whenever you do a 'commit' to your CB2SVN-enabled Subversion repository.

Select a tracker item from the list presented, and CB2SVN will do the rest for you (updating the tracker items in CodeBeamer that you've selected so that the changes can be easily tracked, and adding a revision property to Subversion so that you can find the issues from Subversion).

Starting the Client Manually

We recommend that you start the CB2SVN Client automatically on logon (see the Administration Guide for details). If you prefer not to do this, you can easily start the client manually with the configuration of your choice like so:

c:\Program Files\Clearvision\cb2svn\client\cb2svn_client.exe -f c:\my_cb2svn.cfg

or, on Linux, something like:

/opt/Clearvision/cb2svn/client/cb2svn_client -f ~/.cb2svn.cfg

Working on Multiple Projects

Starting the client manually (as above) can be useful if you are switching between multiple projects, and hence have to use multiple Subversion repositories. In this case, you should set up a set of config files, each configured for the CB2SVN server (and hence Subversion repository) of each project. (You can run multiple clients on the same machine).

Using this configuration, CB2SVN tracks the changes in all the Subversion repositories and helps you to select issues from the related database.

Tracking Changes

CodeBeamer together with CB2SVN provides bi-directional tracking, enabling you to track the Subversion changes from within CodeBeamer, and correlating CodeBeamer records from within Subversion.

In CodeBeamer, you can see associations with tracker items on the SCM Repository tab.

In Subversion, you can interrogate a revision's clearvision:change_id property. This holds a list of the tracker items id's which relate to a change/commit. So, for example, to see which issues relate to the latest change, you can use the following command:

svn proplist -rHEAD --verbose --revprop .


Copyright (c) 2009 Clearvision CM All Rights Reserved
Registered in England No. 5643578 VAT Registration No. UK881364801
Registered Address Laurel Farm, Winters Hill, Durley Southampton, SO32 2AH

http://www.clearvision-cm.com