Contents > Technical Reports > Migration Toolkit > Contributing to RUBRIC Central using Subversion

Contributing to RUBRIC Central using Subversion

1 About this document
2 Introduction
3 Download Subversion
4 Commands you may need along the way
5 Download the Partner directory
6 Edit files
7 Sending changes to RUBRIC-Central
- 7.1 RUBRIC-Central staff to make changes
- 7.2 Partner to implement changes using subversion

1 About this document

Author(s): Bron Dye, RUBRIC Technical Officer
Purpose: This procedure outlines the process for Project Partners to contribute to RUBRIC-central using the subversion client on a Windows platform.
Audience: RUBRIC Project Managers, with VITAL repositories
Requirements: Access to rubric-central.usq.edu.au which hosts the RUBRIC wiki and TRAC ticketing system; A basic understanding of a command line interface in Windows
References: Subversion Online Reference Book:
http://svnbook.red-bean.com/; Subversion:
http://subversion.tigris.org/; TortoiseSVN(optional):; http://tortoisesvn.tigris.org/
Notes:: Instead of using the Command Window, you may like to download TortoiseSVN which integrates easily with Windows Explorer.

2 Introduction

RUBRIC-central stores the partner VITAL configuration files and other relevant documents in a central location on the server: https://rubric-central.usq.edu.au. The partner files can be downloaded and modified using Subversion.

Subversion is a version control system enabling different users to remotely access and modify the same set of documents. These instructions are designed to help Project Partners access and make changes to their own files.

Once these changes are completed, Partners are to notify RUBRIC-central tech team for their implementation.

3 Download Subversion

Subversion is available for download at http://subversion.tigris.org/project_packages.html

Download version 1.3.1 for Windows operating system - svn-1.3.1-setup.exe
Run the setup.exe file
Follow instructions from the Subversion Setup Wizard.

4 Commands you may need along the way

To determine which files you have changed:
```
svn status
```
To reset your copy of a single file to the latest copy at RUBRIC-central (ie: throw away any changes you've made locally):
```
svn revert [path to file]
eg: svn revert C:\Macquarie\2_1\scripts\vital-configuration.xml
```
To output a line-by-line description of ALL the changes to the entire directory in a format that makes it easy for us to incorporate with the existing documents:
```
svn diff 
```

To output details of changes to only one file:

svn diff [path to file] 
eg: svn diff C:\Macquarie\2_1\scripts\vital-configuration.xml

To update your local copy of the files from the latest copy at RUBRIC-central:
```
svn update 
```

5 Download the Partner directory

“Check out” is the command Subversion uses to download documents. The “check out” process creates a working copy on your local machine of the files that are stored centrally. In this case, the Project Partner directory on rubric-central.usq.edu.au is checked out to the Project Partner's own machine.

To check out the directory, open a command window, as follows:

Open the command prompt:
```
Start > Run > cmd
```
A prompt window will appear, similar to this:
Type “C:” at the prompt to ensure you are working in C: drive.

Checkout a working copy of files to your local machine using Subversion:

svn co https://rubric-central.usq.edu.au/svn/config/vital/partner/[PartnerName]
eg: svn co https://rubric-central.usq.edu.au/svn/config/vital/partner/Macquarie

Note:: You will need to enter your rubric-central username and password; If you need clarification of the [PartnerName] used, please contact RUBRIC-central

6 Edit files

Once you have an up-to-date copy, you will be able to edit files without affecting with changes others may have made. Using the command window, navigate to the directory on your machine and update files.

Open the command window:
```
Start > Run > cmd
```
Change to the directory containing your local copy.
```
C: 
cd [PartnerName]
```
Update your local copy from the latest copy at RUBRIC-central by typing the following command in the command window:
```
svn update 
```
Navigate to the file in C drive, using Windows explorer.
Open file and edit.
Save.

7 Sending changes to RUBRIC-Central

You can send your changes to RUBRIC-Central using one of two methods.

You can send a patch file via ticket to RUBRIC-Central staff to make the changes to the latest version on your behalf, please follow 7.1 (below), or
You can make the changes to the latest version using subversion. If you would like to use this method, please contact RUBRIC-Central for extra permissions to be added to your current access, then follow 7.2 (below)

7.1 RUBRIC-Central staff to make changes

7.1.1 Update your copy from the source

Using the command window, navigate to the directory on your machine and update files. This is necessary because other users may have updated the same files and this ensures the most recent changes will be downloaded to your machine.

Change to the directory you wish to update, then run update:
```
cd [path to directory]
svn update 
```

graphics3

7.1.2 Create a patch file

Using command line:

svn diff > [partnername]_patch.diff
eg: svn diff > Macquarie_patch.diff

7.1.3 Submit to RUBRIC-central using a Trac Ticket

To submit the patch file, you need a ticket.

Access the Trac site: https://rubric-central.usq.edu.au/projects/trac/rubric/report

If the issue or request has been recorded already on a ticket, use the existing ticket. If this is a new request, create a ticket and explain the changes as clearly as possible.

When you have created a ticket, click Attach File and attach your patch file. Note: If you wish to add any new files, please add them to the ticket with filepath details to ensure correct placement of the file.

7.2 Partner to implement changes using subversion

7.2.1 Update your copy from the source

Change to the directory you wish to update, then run update:
```
cd [path to directory]
svn update 
```

graphics4

7.2.2 Check status of your local copy

Use svn to find out if files need to be added
```
svn status
```
If any files have a ? indicator, meaning that they are not under version control, add them as follows:
```
svn add [path to file]
eg: svn add C:\Macquarie\2_1\scripts\banner.jpg
```

7.2.3 Commit local changes to RUBRIC-Central

Once you are satisfied that all files are ready to be sent to the latest copy at RUBRIC-Central, run the subversion commit command with a clear message noting the changes made.

svn commit -m “[Enter message here]”
eg: svn commit -m “Changed sort order in summary_footer.xsl”

7.2.4 Update pilot repository

To update the pilot repository version with the changes, send a ticket via TRAC to RUBRIC-Central requesting that they be updated for you. RUBRIC-Central staff will be able to advise of the time frame required to implement this update for you.