Documentation - Redmine Issue Sync¶

Synchronize issues between projects

Redmine Issue Sync is a plugin which lets the user synchronize issues between projects.

• Table of contents
• Documentation - Redmine Issue Sync
  • Getting Started
    • Dependencies
    • Downloading the plugin
    • Restart Redmine
  • Plugin Usage
    • Global Settings
      • Project
      • Trackers
      • Custom Field
    • Project related Settings
      • System project
      • Possible values
  • Unistall
  • Changelog
  • Licence

Getting Started¶

This quick introduction shows you the most convenient way for trying out the plugin with your Redmine instance.

Dependencies¶

To run the plugin you need the following dependencies installed:

• Redmine 5.0.z
• Advanced Plugin Helper 0.4.z
• Redmine Base Deface master

Downloading the plugin¶

Navigate into the plugins directory of your Redmine instance.

Download the latest development state as redmine_issue_sync folder
into your plugin directory.

cd (REDMINE_ROOT_DIR)/plugins
git clone https://github.com/xmera-circle/redmine_issue_sync.git

Restart Redmine¶

Navigate into the root directoy.

Run the restart Rake task. This will touch restart.txt in order to force Redmine's application server to restart and load
everything from scratch. This will register the new plugin.

cd (REDMINE_ROOT_DIR)
rake restart

Plugin Usage¶

Global Settings¶

Navigate to the plugin configuration page in order to define some base settings.

Project¶

First define the issue catalogue. For doing so, you need to select the project containing the relevant issues.

Trackers¶

In case your issue catalogue contains issues with different trackers, you should select the trackers you would like to include into the synchronisation process.

Custom Field¶

If you like to narrow the issue set down to a subset, then choose an appropriate custom field for that.

Project related Settings¶

There are some more setting in each project required.

System project¶

A system project gets all synchronised issues even when they refer to subprojects.

Possible values¶

When you have selected a custom value field in the global settings, then you need to select the corresponding value in the project at hand.

Unistall¶

In order to unistall the plugin you need to undo the migration first:

bundle exec rake redmine:plugins:migrate NAME=redmine_issue_sync VERSION=0

and delete the plugin settings last:

bundle exec rake plugins:settings:clear

Changelog¶

Every release comes along with a list of notable changes in order to make it easier to follow up on the progress of Redmine Issue Sync.

All those changes are documented in source:CHANGELOG.md.

Licence¶

Copyright © 2020-2023 Liane Hampe (liaham@xmera.de), xmera Solutions GmbH.

This plugin is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This plugin is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.