Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 4.41 KB

InstallAndSetupSvn.md

File metadata and controls

82 lines (56 loc) · 4.41 KB

Installation / Setup

Install

  • Download the installer from the downloads tab above.
  • Run the installer; with Vista/Windows 7 This may require accepting UAC windows.
  • Accept the License Agreement (if you agree with it) MIT LICENSE.
  • Continue the installation to completion.

Setup

Prerequisites

  • TortoiseSVN
  • Something using TortoiseSVN (A Working Repository)
  • Basic understanding of terms like "Working Directory / Repository"

Configuring the TortoiseSVN Redmine Plugin

  • Browse to The folder containing the repository you wish to hook up to your Redmine issues list.

  • Right click on the folder and go to Settings under the TortoiseSVN menu. ../Images/Screenshots/tsvn01.png

  • In the Settings dialog, select Issue Tracking Integration and click the Add button. ../Images/Screenshots/tsvn02.png

  • To configure Issue Tracker Integration for TurtleMine you need to specify three values.

    1. Set the Working Copy Path to the local repository location.
    2. Set the Provider to the TurtleMine Provider. (If this is the only provider you have it will most likely be pre-selected).
    3. Set the Parameters field to the ATOM Feed URL from your Redmine Issues Page for the issues that you wish to be available to include in your commit comments. (See below for more details).

To get the ATOM Feed URL

  • Browse to the issue list you wish to use.

  • At the bottom of the page will be a link to the ATOM Feed for the page. Right click on this link and copy the URL or shortcut.

  • Paste this URL into the Parameters field mentioned above. ../Images/Screenshots/tsvn03.png

  • Your final configuration should look something like the below. ../Images/Screenshots/tsvn04.png

  • Click on the Options button to test your connection or configure connectivity options. (this step is optional)

    • Click Test to test the connection to Redmine and retrieval of the issues list.
  • Click on Connection Settings to expand the Connection Settings options to configure your Proxy Server, Authentication, or SSL requirements. ../Images/Screenshots/tsvn05.png

../Images/Screenshots/tsvn06.png

  • Once you click OK and return to the Tortoise SVN window, you should now see the listing in the Issue Tracking Integration list. ../Images/Screenshots/tsvn07.png

Using the basic functions of TurtleMine

  • Bring up the TortoiseSVN commit dialog as you would normally do so. There will be a new Redmine Issues button at the top right of the dialog window. ../Images/Screenshots/tsvn08.png

  • Click the Redmine Issues button to bring up the TurtleMine window. ../Images/Screenshots/tsvn09.png

  • Here you will be able to select a Redmine issue to include in your commit message. Some of the functionality is listed below.

    • A) A basic search box to search within the issues.
    • B) A drop down list to choose which fields to search on, the default is all fields.
    • C) A Next button to move the selection through the found results.
    • D) A Check button to select (check) all highlighted or found issues.
    • E) The main issue list display window.
    • F) The Issue Description window (this is hidden by default, See I for details).
    • G) Opens your default web browser to the page for the selected Redmine issue.
    • H) Opens your default web browser to the page for Time Entry page for the selected Redmine issue.
    • I) Toggles the description window visibility.
    • J) If selected, includes the issue summary text as well as the issue number in your commit message.
    • K) Ok, to add the selected issues to your commit message, otherwise Cancel adding issues.
  • You can also right click in the main issue list window to bring up display customization options. ../Images/Screenshots/tsvn10.png

  • Select the issue number you wish to include then click OK. The Issue number/s will be appended to the end of your existing commit message. ../Images/Screenshots/tsvn11.png