/phabmine

Phabricator + Redmine

Primary LanguageRuby

Phabmine

Phabmine is Redmine plugin that integrates wth Phabricator and allows to check issue related commits statuses from issue view.

Features

  1. Show commits result statuses (based on audit of different users) on issue page.
  2. Change commit URL from redmineweb (which is default) to phabricator.

Installaion

  1. Change to Redmine plugins directory (varies by version).
  2. git clone git@github.com:futurecolors/phabmine.git && cd phabmine && git submodule init && git submodule update
  3. Install Phabricator Arcanist, run arc install-certificate <phabricator url> and follow instructions. You must have ~/.arcrc after this step.
  4. Create a link to .arcrc file from phabmine directory.
  5. Reload redmine.

##Configuration Plugin settings (/settings/plugin/phabmine page) has following settings:

  • Roles to hide Phabricator URL
    This is JSON list of user rolse ids. If user belongs to one of this roles, commit URL to redmineweb will not be changed to phabricator URL. This is usefull if someone has no access to phabricator or need redmineweb for some other reason.

For example, if you wand to disable url change for managers, the parameter should be: [3]

  • Redmine->Phabricator project mapping
    This is JSON map of correspondance redmine projects slugs and phabricator projects slug. By default, phabricator project slug is uppercsed redmine project slug.

For example, if redmine project called phabricator-plugin and phabricator project called PHABMINE, then the map should look like this: {'phabricator-plugin': 'PHABMINE'}

If you don't need some of these settings, just leave them empty, that's fine. Otherwise, check JSON correctness. If parameters will not be valid JSON strings, issue page will turn into 500 page. This behavior will be fixed soon.

FAQ

  • I don't want to clutter up my server with Phabricator Arcanist, PHP, etc. What shoud I do to run Phabmine?
    The point of step 3 of installation guide is to get .arcrc file - this is where Phabricator Conduit's certificate stored. You can create the file at any computer and then just copy it to server with Redmine.

  • Is Phabmine stable? Can I safely use it?
    No! The plugin is under development. Production usage is strongly not recommended.