My Tiny Box

Redmine supybot plugin

02/10/2012 à 17:45:39

This Supybot/Limnoria plugin allows to display informations about Redmine issues and direct links to them.

How to install:

The informations are fetched from Redmine through it's Rest API, so you will need to install Restkit (package python-restkit on Debian).

How to configure:

It is based on the Mantis/Bugzilla plugins, so it uses the same command and more or less the same configuration variables:

* urlbase: The base URL for the Redmine instance this plugin will retrieve bug informations from.

* apikey: Your Redmine API key. The Rest API must be enabled in Redmine in Administration -> Settings -> Authentication. You can then get your API Key on your account page ( /my/account ) when logged in, on the right-hand pane of the default layout.

* bugMsgFormat: Change the message format for bug details, following tokens will be replaced before being printed: _ID_, _URL_, _AUTHOR_, _CATEGORY_, _SUBJECT_, _STATUS_ . _CRLF_ will split the response in two (or more) lines.

* bugSnarfer: Determines whether the bug snarfer will be enabled, such that any bug ### seen in the channel will have its information reported into the channel. Channel Specific variable.

* bugSnarferTimeout: Users often say "RM XXX" several times in a row, in a channel. If "RM XXX" has been said in the last (this many) seconds, don't fetch its data again. If you change the value of this variable, you must reload this plugin for the change to take effect.

How to use:

Once the plugin is loaded and (at least) urlbase and apikey are set, you can display informations about a Redmine issue with the "bug #" command, where # is the issue number.
If you enable the bugSnarfer variable for a given channel, you won't need using the "bug" command anymore, just write "RM #", and the bot will automatically display informations about the issue.

Available on github:

IRC, Limnoria, Redmine, Supybot

Aucun commentaire

Flux RSS des commentaires de cet article

Les commentaires sont fermés pour cet article