Introduction
This document contains a brief example of how to use Clearvision's Agile SCM in the provided sandbox environment, while this is one example of a development workflow and use please note the environment is provided for users to experiment and following this guide is not essential.
Pre-requisites
The provided environment is a standalone server and requires no installation on your part to access other than a web browser and connection. However for full functionality there are two requirements for your remote access machine.
In order to use any checkout functionality you will need to have a command line svn client installed and on your path at version 1.6 or later:
http://subversion.apache.org/packages.html
In order to use the Java checkout functionality (which we recommend) you will also need to have java installed no earlier than version 5:
General Notes
The sandbox environment provides the following:
- Agile SCM server
- Atlassian Jira integrated with Agile SCM
- Hosted subversion integrated with Agile SCM.
- Default database
Please note that while a full Agile SCM server can be used with Git and Mercurial CM tools this functionality is not provided with the sandbox, Full integrations with Trac, Clearquest and ReviewBoard are also not provided for the demonstration.
Getting Started
Navigate to http://www.clearvision-cm.com:54323/
You will be presented with the login screen. The default login for the admin user is:
User : demo
Password: demo
This user will allow you full administrative rights to the sandbox, please note that no database admin rights are available.
The to-do page
This page lists everything assigned to the "demo" either in an activity waiting to be accepted, at which point a branch will be created, or in an in progress state, at which point a branch already exists. These activities are also listed as to which project they are a part of.
Activities
To create an activity simply select the new activity tab, new activities can be created from Agile SCM, Jira, Clearquest and Trac, this demonstration allows only Agile SCM and Jira activities. To create an Agile SCM activity Simply select a project from the drop down list (ensure that the user you wish to assign the activity to is a member of the selected project, as a guide the user "demo" is a member of both the "Jira project" and the "demo project"). Give the activity a meaningful name and enter a detailed explanation in the description box. Once done click on "AgileSCM Demo User" to assign it to yourself, alternatively hold ctrl to assign an activity to multiple users or leave it unselected to assign the activity later (through the assign activity tab). Finally click "Create Activity".
If you assigned the activity to yourself it will now appear in your to-do page as assigned, go there now.
Branching
Each time an activity is accepted Agile SCM creates a branch for the developer to work on. To achieve this simply tick the "accept" box next to the activity you just created and select "Take Action". After the server has finished you can find this activity has moved to the "In Progress" section.
Checking out and Working on an activity
In the branch column of activities in progress on the to-do page are a number of options as means of creating a working copy of an activity. Firstly the text provided can be pasted directly onto a command line, independent of operating systems this will create a working copy in a location relevant to the current directory. The windows batch file or Linux can be used in their relevant systems or lastly the Java checkout GUI can be used (See pre-requisites). This provides a means of storing passwords and usernames for authenticated SVN repositories and choosing the location of the created working copy. Once created you can make any changes to the working copy, note that anything created in Agile SCM as read-only will have the relevant permissions adjusted in the working copy.
Checking In
Agile SCM is fully compatible with all subversion clients, after checking otu and working on an activity you can use your preferred method of commiting the changes to the SVN repository. The Java checkout GUI provides an option to "check in" an ativity. Note this will only commit changes, it will not perform a subversion add command on new files or directories so this must be completed through an svn client first.
Delivery/Merging
When an activity is completed you can select the "deliver" tick box to merge the data into the subversion main branch. Any merge conflicts at this point will be notified and checkouts provided to manually resolve the conflict. Alternatively the "close" tick box can be used , this is the only option when there are multiple assignees to one activity. Once closed the activity will not be merged but will instead be considered closed by Agile SCM and will await an integrator to perform the merge, this can also be used to allow integrators to perform reviews on activities. Note that if a project is not set to "allow developers to deiver" then the deliver option is greyed out and an activity must be closed, reviewed and integrated separately.
Baseline's and Subversion Tags
In Subversion releases and builds are managed by Tags, this is maintained in Agile SCM by Baseline's. From the "Manage Baseline" tab (users without admin permissions will only see the "view Baseline" tab), you can view, checkout, manage and create Subversion tags, or perform a hotfix on a baseline.
Select the project your activity was created in from the drop down box and if it has been delivered/integrated it will be visible as an activity that has not yet been baselined. To create a new baseline, and therefor a new build candidate, simply give it a meaningful name and select to "Make Baseline".
Baselines can be checked out from this page in the same way as activities, however as the workspace is not created from an activity, changes cannot be commited.
Other Features
From this point you have been through an entire developers cycle of one activity, from here you can make new activities, projects or users. Alternatively why not experiment with Agile SCM's other features such as user management and re-assigning activities, or new to version 3.0, the releases tab, which allows baselines to be grouped into releases. For more information on these or any other features of Agile SCM please see the documentation. This is available in the sandbox from the "help" option at the top right of any page or from the Clearvision website: