Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 4.05 KB

README.md

File metadata and controls

81 lines (51 loc) · 4.05 KB
Raw

Redmine GitHub plugin

redmine_github is a Redmine plugin for connecting a local Redmine installation to a remote GitHub repository. The plugin allows to:

  • Syncronize remote GitHub repository to a local Git one - all Git-related Redmine features can be used
  • Attach pull request (PR) status icons to issues - will change in real time, when pul request status change - created, approved, merged etc.
  • Connect commit comment to issues via Redmine commit comments keywords

Getting started

1. Install the plugin

cd {LOCAL_REDMINE_DIRECTORY}/plugins

From downloaded release archive file

tar xvzpf redmine_github....

or via Git clone

git clone https://github.com/agileware-jp/redmine_github.git

Install gems and migrate the database

cd {LOCAL_REDMINE_DIRECTORY}
bundle install
bundle exec rake redmine:plugins:migrate

Restart you Redmine

After restart, also check if plugin is listed in the installed Redmine plugins list - (Administration|Plugins)

2. Add the repository to Redmine

For given project, in _(Settings|Repositories|New Repository) form enter:

After pressing 'Create' button, bare-clone repository will be created inside your Redmine install directory - {LOCAL_REDMINE_DIRECTORY}/repositories/ path.

Note the repository ID in the 'Edit' and 'Delete' links - you will need this for the next step (webhook url)

3. Connecting GitHub to Redmine

  1. Go to the repository Settings interface on GitHub.
  2. Under Webhooks add a new webHook:
  • The Payload URL needs to be of the format: [redmine_url]/redmine_github/:repository_id/webhook (for example http://redmine.example.com/redmine_github/1/webhook). Repository ID is the one of the created in the previous step repository
  • Content type: application/json
  • Secret: same as Webhook Secret inside you Redmine repository settings
  • Which events would you like to trigger this webhook? - Pull requests, Pull request reviews, Pull request review comments, Pushes, Statuses, Commit comments

4. Configure commit comments keywords

In (Administration|Settings) , Repositories tab configure commit comments keywords.

Documentation

Read redmine_github plugin wiki pages (still WIP).

License

Copyright © 2019 Agileware Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.