Skip to content
This repository has been archived by the owner on Apr 4, 2022. It is now read-only.

Commit

Permalink
Merge pull request #238 from github/fix-readme
Browse files Browse the repository at this point in the history
Update README.md - Enhance Hubot commands and remove Campfire support
  • Loading branch information
mattr- committed Jan 29, 2018
2 parents 7239da2 + 566d264 commit e22594b
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,29 +24,37 @@ Hubot usage
-----------

Start by setting up a new Jenkins job and GitHub web hook for a
repository:
repository: `[ORG]/[REPO]`

hubot ci setup github/janky

The `setup` command can safely be run over and over again. It won't do
anything unless it needs to. It takes an optional name argument:
anything unless it needs to. It takes an optional `name` argument: `[ORG]/[REPO] [NAME]`

hubot ci setup github/janky janky-ruby1.9.2

It also takes an optional template name argument:
It also takes an optional `template` argument: `[ORG]/[REPO] [NAME] [TEMPLATE]`

hubot ci setup github/janky janky-ruby1.9.2 ruby-build

All branches are built automatically on push. Disable auto build with:

hubot ci toggle janky
hubot ci toggle [REPO]

**NOTE**: If `name` was set you'll need to use it intested.

hubot ci toggle [NAME]

Run the command again to re-enable it. Force a build of the master
branch:

hubot ci build janky
hubot ci build [REPO]

**NOTE**: If `name` was set you'll need to use it intested.

hubot ci build [NAME]

Of a specific branch:
Of a specific branch: `[REPO]/[BRANCH]`

hubot ci build janky/libgit2

Expand All @@ -55,7 +63,7 @@ lets you choose where notifications are sent to. First get a list of
available rooms:

hubot ci rooms

Then pick one:

hubot ci set room janky The Serious Room
Expand All @@ -64,7 +72,7 @@ Get the status of a build:

hubot ci status janky

Specific branch:
Specific branch: `[REPO]/[BRANCH]`

hubot ci status janky/libgit2

Expand Down Expand Up @@ -192,15 +200,6 @@ respectively.

### Chat notifications

#### Campfire
Janky notifies [Campfire][] chat rooms by default. Required settings:

* `JANKY_CHAT_CAMPFIRE_ACCOUNT`: account name.
* `JANKY_CHAT_CAMPFIRE_TOKEN`: authentication token for the user sending
build notifications.

[Campfire]: http://campfirenow.com/

#### HipChat

Required settings:
Expand Down

0 comments on commit e22594b

Please sign in to comment.