Redmine

Reference Redmine issues in Bitbucket.

This is both a Redmine plugin and an Atlassian Connect for Bitbucket Cloud compatible add-on.

Features¶

• A Bitbucket linker that makes Bitbucket turn references to issues using a specified regex turn into links to the issue in Redmine;
• Bitbucket webhooks for pushes, commit comments, pull requests and pull request comments. These webhooks get handled in the Redmine plugin, creating a journal entry for the issue containing the commit message or comment and useful links and meta-data.

Since the linker and webhooks are registered using an addon they automatically work for all repositories of the user / team for whom the addon is installed.

Limitations¶

• Currently the regex is hardcoded to `(?<!&)#([0-9]+)`, meaning issues have to be referenced using `#<issue number>`. The negative lookahead is a workaround for Bitbucket bug 13642.
• Currently only up to 5 commits per push are supported because of a limitation in Bitbucket's push webhook.
• Issue references in pull request edits, pull request comment edits or commit comment edits will not cause Redmine journals to be updated or added.

First, install the plugin in Redmine¶

From your Redmine installation directory:

• Download or clone this repo

    mkdir plugins/bitbucket_reference_redmine
    wget -qO - https://bitbucket.org/productize/bitbucket_reference_redmine/get/master.tar.bz2 | tar jx --strip-components=1 -C plugins/bitbucket_reference_redmine

    git clone https://bitbucket.org/productize/bitbucket_reference_redmine.git plugins/bitbucket_reference_redmine

• Install the plugin's dependencies

    bundle install

• Run the migrations

    bundle exec rake redmine:plugins:migrate

• Restart Redmine

  E.g, if Redmine is installed as an Apache 2 passenger:

    sudo service apache2 restart

    sudo service redmine restart

Next, install the addon in your Bitbucket user/team:¶

• Navigate to https://bitbucket.org/account/user/user_or_team_name/addon-management
• Click "Install add-on from URL"
• Enter <base URL of your Redmine installation>/bitbucket-references
• Click "Install"
• Click "Grant access"
• You will now get redirected to the plugin's settings page in your Redmine instance, This might require you to log in.
• Click "Allow" on the Bitbucket connection you just added.

Notes¶

• The Bitbucket Connect system requires your Redmine installation to use HTTPS.
• To add a second Bitbucket account make sure the "Allow new Bitbucket connections" option is enabled on the plugin's configuration page.