blob: 3d9ef3752a7c0437b5730f957566ec81b6616222 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
.. supybot-github documentation master file, created by
sphinx-quickstart on Fri Mar 18 15:54:33 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to supybot-github's documentation!
==========================================
**supybot-github** is a plugin for the python-based IRC bot `Limnoria`_ (and any
`Supybot`_ forks). Its purpose is to announce commits and other important
notifications from a `Github`_ repository on an IRC channel, using
`Github's webhooks`_.
The plugin is built to be highly configurable and extendable.
It's still in the beta phase, although it is quite usable.
Features
--------
Do note that most of these features are only partially complete:
- Support for a bunch of different Github events
- Support for `Travis`_ build notifications
- Support for Github `webhook secrets`_
- Different message themes
- A bunch of configuration options
- Increases the count of errors in your logs
.. _Supybot: https://sourceforge.net/projects/supybot/
.. _Limnoria: https://github.com/ProgVal/Limnoria
.. _Github: https://github.com/
.. _`Github's webhooks`: https://help.github.com/articles/about-webhooks/
.. _`Travis`: https://travis-ci.org/
.. _`webhook secrets`: https://developer.github.com/webhooks/securing/
Installation
------------
See :ref:`getting-started`.
Resources
---------
- Issue Tracker: https://github.com/kongr45gpen/supybot-github/issues
- Source Code: https://github.com/kongr45gpen/supybot-github
Support
-------
If you are having issues, please open up an issue at the
`issue tracker <https://github.com/kongr45gpen/supybot-github/issues>`_.
You can also pay a visit to the :code:`##alezakos` channel on the Libera.Chat IRC network.
Further Reading
---------------
.. toctree::
:maxdepth: 2
getting-started
configuration
|
