Project

octospy

0.01
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Octospy notifies events of github repositories to IRC channels.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0

Runtime

~> 2.0
~> 0.10
~> 2.7
~> 0.5
 Project Readme

Octospy

Gem Version Build Status Dependency Status Code Climate Coverage Status

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

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Authors

License

The MIT License (MIT)