robhurring / hubot-redmine

Redmine API scripts for Hubot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Help text includes config information

abeger opened this issue · comments

I installed the latest version and I see the following when I type hubot help (removed other commands):

hubot> hubot help
(redmine|show) me <issue-id>     - Show the issue status

---
After that, heroku needs the following config
If you are using redmine over HTTPS, add the following config option
There may be issues if you have a lot of redmine users sharing a first name, but this can be avoided
To get set up refer to the guide http://www.redmine.org/projects/redmine/wiki/Rest_api#Authentication
add <hours> hours to <issue-id> ["comments"]  - Adds hours to the issue with the optional comments
assign <issue-id> to <user-first-name> ["notes"]  - Assign the issue to the user (searches login or firstname)
by using redmine logins rather than firstnames
heroku config:add hubot_REDMINE_BASE_URL="http://redmine.your-server.com"
heroku config:add hubot_REDMINE_SSL=1
heroku config:add hubot_REDMINE_TOKEN="your api token here"
link me <issue-id> - Returns a link to the redmine issue
set <issue-id> to <int>% ["comments"] - Updates an issue and sets the percent done
show (my|user's) issues          - Show your issues or another user's issues
update <issue-id> with "<note>"  - Adds a note to the issue

Oh, I see that #14 fixes this issue.

#14 merged this morning.