Contents

  1. Welcome to Jira2SVN
  2. Using Jira2SVN
    1. Everyday Use
      1. Starting the Client Manually
      2. Working on Multiple Projects
    2. Tracking Changes

Welcome to Jira2SVN

Jira2SVN seamlessly integrates issues recorded and managed in JIRA with file changes held in Subversion repositories. Jira2SVN is designed to enable the developer to work as they want to work, using the client and platform of their choice and supports your existing Change Control process using JIRA.

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

A Jira2SVN system is arranged like this. Typically, as a Subversion user, you will only be concerned with the client piece. Your Administrator will have configured various options for you (you can find out about all of the possible options in the Administration guide):

jira2svn_overview.jpg

Using Jira2SVN

Everyday Use

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

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

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

Select an issue from the issues presented, and Jira2SVN will do the rest for you (updating the issues in JIRA 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 Jira2SVN Client automatically on logon (see the Administration Guide for details). If, for whatever reason, you aren't doing this, you can easily start the client manually with the configuration of your choice like so: 

c:\Program Files\Clearvision\jira2svn\client\jira2svn_client.exe -f c:\my_jira2svn.cfg

or, on Linux, something like: 

/opt/Clearvision/jira2svn/client/jira2svn_client -f ~/.jira2svn.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 Jira2SVN server (and hence Subversion repository) of each project. (You can run multiple clients on the same machine).

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

Tracking Changes

Jira2SVN provides bi-directional tracking, enabling you to track the Subversion changes from within JIRA, and correlating JIRA records from within Subversion.

In JIRA, you can simply open an issue and see the history of your changes relating to this activity in the Jira2SVN tab.

/!\ Note: due to a limitation in the current JIRA API, the 'jira2svn' field will be visible above the tabs. Please 'hide' this field so that you can see the Jira2SVN tab below (we are investigating ways to do this automatically in a future release).

In Subversion, you can interrogate a revision's clearvision:change_id property. This holds a list of the JIRA records 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 .