| 1 | # Hubot GitHub Event Announcer
|
| 2 |
|
| 3 | Announces GitHub webhook events. Gotta catch 'em all!
|
| 4 |
|
| 5 | Currently supports:
|
| 6 |
|
| 7 | 1. Issue Comment events
|
| 8 | 1. Issues events
|
| 9 | 1. Ping events
|
| 10 | 1. Pull Request events
|
| 11 | 1. Push events
|
| 12 |
|
| 13 | All other events it announces by giving you the JSON supplied by the webhook.
|
| 14 |
|
| 15 | ## Installation
|
| 16 |
|
| 17 | Add the package `hubot-github-event-announcer` as a dependency in your Hubot `package.json` file.
|
| 18 |
|
| 19 | ```json
|
| 20 | "dependencies": {
|
| 21 | "hubot-github-event-announcer": "0.3.0"
|
| 22 | }
|
| 23 | ```
|
| 24 |
|
| 25 | Run the following command to make sure the module is installed.
|
| 26 |
|
| 27 | ```bash
|
| 28 | $ npm install hubot-github-event-announcer
|
| 29 | ```
|
| 30 |
|
| 31 | To enable the script, add the `hubot-github-event-announcer` entry to the `external-scripts.json` file (you may need to create this file).
|
| 32 |
|
| 33 | ```json
|
| 34 | ["hubot-github-event-announcer"]
|
| 35 | ```
|
| 36 |
|
| 37 | ## Configuration
|
| 38 |
|
| 39 | The GitHub Event Announcer responds to the URL `http://hubot.example.com/github/events?room=someRoom` where:
|
| 40 |
|
| 41 | 1. `hubot.example.com` is the fully-qualified domain name of your instance of Hubot
|
| 42 | 1. `someRoom` is the name of the chat room where you want announcements to show up
|
| 43 |
|
| 44 | ## Copyright
|
| 45 |
|
| 46 | Copyright © 2015 by [Lee Dohm](http://www.lee-dohm.com) and [Lifted Studios](http://www.liftedstudios.com). See [LICENSE][license] for details.
|
| 47 |
|
| 48 | [license]: https://github.com/lifted-studios/hubot-github-event-announcer/blob/master/LICENSE.md
|