TrackStudio 3.0 Documentation
Up | Next
CVS Integration

This topic describes how to integrate TrackStudio with CVS.

TrackStudio can be integrated with CVS version control system through our SOAP API. CVS check-in messages which are automatically appended to tasks. They can also be bounced by e-mail to the development team. This ensures all changes are logged. 

To implement CVS integration: 

 

  1. enable TrackStudio SOAP API
  2. configure your CVS so that the loginfo will call link.jar to add messages.

 

link.jar is a small utility, which enables you to add messages to the tasks specified in the message body. 

 

Usage:

 

java -jar link.jar --url <URL> --login <LOGIN> --password <PASSWORD>
  • <URL> TrackStudio server URL. The URL must be specified in full. For example, http://mycompany.com:8888/TrackStudio
  • <LOGIN> TrackStudio user Login
  • <PASSWORD> TrackStudio user Password

 

Message to be imported to TrackStudio are taken from standard input (stdin). Message will be added to the tasks specified in the message body like this: #TASK_NUMBER. E.g., message I have done #1 #2 #19 tasks which means, that this message will be added to the tasks with numbers 1, 2 and 19. 

The message, added through the link.jar utility, will have the following properties: 

 

  • submitter –- the user that has specified login.
  • message type, priority, resolution, handler -– values by default
  • deadline, budget, hours –- empty values.

 

To use the link.jar utility you need to add all the necessary instructions to the loginfo administrative file. The loginfo file is used to control where the cvs commit log information is sent. To edit the loginfo file: 

1) Receive the administrative files.

$ cvs checkout CVSROOT

2) Edit the CVSROOT/loginfo file. 

Add the following string to the file

DEFAULT /usr/local/jdk/bin/java -jar /devpack/link.jar
--url http://localhost:8888/TrackStudio --login cvs --password cvs

DEFAULT -- is a regular expression which is tested against the directory relative to the CVSROOT in which the change is being made. If the match is found, the remainder of the line is a filter program that expects log information on its standard input. If the repository name does not match any of the regular expressions in this file, the specified DEFAULT line is used. All occurrences of the ALL name appearing as a regular expression are used in addition to the first matching regular expression or DEFAULT

/usr/local/jdk/bin/java -- JVM absolute path 

/devpack/link.jar -- the link.jar utility absolute path 

cvs -- TrackStudio user login. We recommend you add a new user in TrackStudio to work with CVS. The user must have access to the required tasks and projects. 

cvs -- TrackStudio user password 

3) Execute commit for the loginfo edited file.

$ cvs commit -m "" CVSROOT/loginfo

4) Commit your files

cvs -z9 commit -m "This message should be added to the task #1 and #2."
  2.8_bugs.txt (in directory C:\42\Luxoft)
Checking in 2.8_bugs.txt;
C:/43/luxoft/2.8_bugs.txt,v  <--  2.8_bugs.txt
new revision: 1.16; previous revision: 1.15
done
Adding message to the task #1... done
Adding message to the task #2... done

*****CVS exited normally with code 0*****
Copyright (c) 2002-2004. TrackStudio, Ltd. All rights reserved.