Octospy
Octospy notifies events of github repositories to IRC channels.
Installation
Add this line to your application's Gemfile:
gem 'octospy'
And then execute:
$ bundle
Or install it yourself as:
$ gem install octospy
Usage
$ cp .env.example .env
edit .env:
SERVER=irc.yourserver.net
CHANNELS=yourchannel
GITHUB_TOKEN=e17e1c6caa3e452433ab55****************
github tokens: https://github.com/settings/applications
$ octospy
GitHub Enterprise
add to .env
GITHUB_API_ENDPOINT=http://your.enterprise.domain/api/v3
GITHUB_WEB_ENDPOINT=http://your.enterprise.domain
Specify the dotenv filename
env DOTENV=".env.myserver" octospy
Debug
env DEBUG=true octospy
Commands
format: octospy: <command>
| Command | Description |
|---|---|
watch <repository> |
add repository to watch list (ex: watch rails/rails) |
unwatch <repository> |
remove repository to watch list |
watch <user or organization> |
add user's repositories to watch list (ex: watch dotcloud) |
unwatch <user or organization> |
remove user's repositories from watch list |
clear watched |
remove all repositories from watch list |
start |
start the repository event monitoring |
stop |
stop the repository event monitoring |
join <channel> |
invite octospy to another channel |
show watched |
display the watch list |
show status |
display the joined channels |
help |
display the commands |
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Authors
License
The MIT License (MIT)