Commits and pull requests that mention an issue appear on that issue, live. A
GitHub panel lists linked commits and pull-request cards with their state,
review summary and checks; merges can add a history note, and pull-request
conversation can be mirrored onto the ticket. It is driven by webhooks from a
GitHub App you create and own, reads only, and stores metadata — a commit
message's first line, a pull-request title and state — never code or diffs.
Connecting the external side is covered separately in the GitHub integration guide.
On your own Redmine
Requirements
- Redmine 6.0 or newer (Rails 7.2, Ruby 3.1 or newer)
- PostgreSQL 14+, or MySQL 8.0+ / MariaDB 10.6+
- The
jwtgem, declared in this feature's ownGemfileand used to sign the App token — sobundle installis required here, unlike most of the suite - A GitHub App you create; no personal access tokens are ever stored
- The workspace must be reachable from GitHub over HTTPS for webhooks to arrive
Install
cd /path/to/redmine
cp -r redminepro_github plugins/
bundle install
RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=redminepro_github
# restart Redmine
Then follow the GitHub integration guide to create and install the App.
Standalone behaviour
Identical. No plan gate applies and nothing is capped by tier. The module is a real one and keeps its checkbox in project settings.
Update and remove
Copy the new directory over the old one, run bundle install and the migrate
command, restart. To remove:
RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=redminepro_github VERSION=0
rm -rf plugins/redminepro_github
# restart Redmine
Delete or uninstall the App on GitHub afterwards, or it keeps sending deliveries to an address that no longer answers.
Already on RedminePRO Cloud? It is installed and maintained for you: see the configuration guide.