Redmine integration setup guide

Follow

Screen_Shot_2012-03-07_at_4.45.07_PM.png

Overview

BugHerd's integration with Redmine will allow you to sync BugHerd tasks to Redmine Issues. The Redmine integration can be setup as bi-directional. If you configure the BugHerd Web Hook, then when a BugHerd synced issue is modified in Redmine, it will be updated in BugHerd as well.

Because Redmine and BugHerd's bug statuses and priorities are different from Redmine, you can fully customise the mappings.

How it works

When the integration has been setup fully, here's the information that is synchronised:

  • Bug description -> issue description, and the subject (subject truncated to 80 characters)
  • Bug assignee -> issue assignee, if the user exists in Redmine (defaults to integration owner)
  • Bug status -> issue status, depending on whether the value is mapped (details below)
  • Bug priority -> issue priority, depending on whether the value is mapped (details below)
  • Bug comments
All of the above data will also be synchronised back to BugHerd, when the Web Hook is correctly configured.

Configuration

Important: your Redmine server needs to have the BugHerd for Redmine plugin installed. Please find all code and instructions here:

https://github.com/bugherd/redmine_bugherd

BugHerd will not be able to authenticate against your Redmine server until the plugin is installed!

Next, enable the REST API if this hasn't been done. Go to Administration > Settings > API, select "Enable REST web service" and click Save.

To add a Redmine integration to your BugHerd account, select integrations at the top of the BugHerd project management pages. On the Integrations page, find Redmine and select "add integration".

Screen_Shot_2012-03-13_at_3.05.34_PM.png

Complete these fields:

  • URL: this is the URL in the form http://myredmine.company.com
  • API Key: your Redmine administrator's API Key (available on the "My Account" page, click "Show" under "API access key")

Once BugHerd has verified your token, click save to go to the next page. Here you will be able to configure your status and priority mapping. Note: you may skip this step if you do not yet have a good grasp of how you wish to incorporate BugHerd into your process, you can come back here any time from the main integrations screen any time.

Screen_Shot_2012-03-13_at_3.15.32_PM.png

Now that your Redmine integration has been created, you can start connecting BugHerd projects you own to your Redmine projects. Please create a BugHerd project if you do not own any projects yet. To start connecting projects, click on the projects link on the Redmine integration:

Screen_Shot_2012-03-13_at_3.17.46_PM.png

On the projects screen, pick a BugHerd project you own from the dropdown on the left, and a Redmine project from the one on the right. Then to connect the projects, click add:

Screen_Shot_2012-03-13_at_3.32.50_PM.png

Note that any Redmine project you select must contain the "Bug" tracker, please enable it in order for BugHerd to be able to create issues. This is because all bugs will be synced to tracker "Bug":

Screen_Shot_2012-03-13_at_3.39.47_PM.png

Once you have created the link between the projects, BugHerd will start syncing any new bugs to Redmine. If you also would like to synchronise any changes made to BugHerd created issues back, you need to setup the Web Hook. Click configure next to the Redmine project. The Web Hook configuration dialog will appear:

Screen_Shot_2012-03-13_at_3.34.56_PM.png

Copy the unique key provided and paste it into field BugHerd Project Key on the Redmine project's Settings page:

Screen_Shot_2012-03-13_at_3.37.02_PM.png

Note: the field BugHerd Project Key should have been created as part of the setup steps when installing and configuring the plugin.

Once you have clicked save in the Redmine project settings, you can verify that the key works using the verification link on the configuration dialog. If you see a message web hook is active, congratulations, your setup is complete! Now if you create or update a task in BugHerd, you will see the change in your Redmine project under the Issues tab.

If you experience any issues, help is only a quick message away, please open a support ticket and we'll get back to you as soon as possible.

Have more questions? Submit a request

Comments

Powered by Zendesk