2008-12-04 14:57:37 -08:00
|
|
|
# commitbot
|
|
|
|
|
|
|
|
|
|
Commitbot is an XMPP bot that notifies multi-user chat rooms (MUCs) of
|
|
|
|
|
git repository commits.
|
|
|
|
|
|
|
|
|
|
It uses the [GitHub](http://www.github.com) post-receive web hook to
|
|
|
|
|
get push notifications of repository changes.
|
|
|
|
|
|
2008-12-04 15:01:08 -08:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
This code is copyright (c) 2008 by Jack Moffitt <jack@metajack.im> and
|
|
|
|
|
is available under the [GPLv3](http://www.gnu.org/licenses/gpl.html).
|
|
|
|
|
See `LICENSE.txt` for details.
|
|
|
|
|
|
2008-12-04 14:57:37 -08:00
|
|
|
## Dependencies
|
|
|
|
|
|
|
|
|
|
* [Twisted](http://www.twistedmatrix.com) 8.1.x or later
|
|
|
|
|
* [Wokkel](http://wokkel.ik.nu) 0.4 or later
|
|
|
|
|
* [simplejson](http://pypi.python.org/pypi/simplejson)
|
|
|
|
|
|
|
|
|
|
Note that on Ubuntu/Debian systems Twisted is split into various
|
|
|
|
|
pieces. You will want:
|
|
|
|
|
|
|
|
|
|
* python-twisted-words
|
|
|
|
|
* python-twisted-names
|
|
|
|
|
|
|
|
|
|
in addition to the normal Twisted package.
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Copy `commitbot.tac.example` to `commitbot.tac` changing the JID,
|
|
|
|
|
password, room name, and room nickname to something appropriate. Then
|
|
|
|
|
launch it with `twistd`.
|
|
|
|
|
|
|
|
|
|
twistd -y commitbot.tac
|
