Limnoria-doc/use/plugins/github.rst
2011-10-29 13:29:17 +02:00

2.2 KiB

The GitHub plugin

Main commands

github repo info <owner> <repository> [--enable <feature> <feature> ...] [--disable <feature> <feature>]

Displays informations about <owner>'s <repository>. Enable or disable features (ie. displayed data) according to the request).

Searches the string in the repository names database. You can specify the page <id> of the results, and restrict the search to a particular programming <language>.

Announces

github announce remove [<channel>] <owner> <name>

Don't announce the commits of the GitHub repository called <owner>/<name> in the <channel> anymore. <channel> defaults to the current channel.

github announce add [<channel>] <owner> <name>

Announce the commits of the GitHub repository called <owner>/<name> in the <channel>. <channel> defaults to the current channel.

Configuration

supybot.plugins.GitHub.api

supybot.plugins.GitHub.api.url

Default value: http://github.com/api/v2/json

The URL of the GitHub API to use. You probably don't need to edit it, but I let it there, just in case.

supybot.plugins.GitHub.announces

Default value:

You shouldn't edit this configuration variable yourself, unless you know what you do. Use '@Github announce add' or '@Github announce remove' instead.

supybot.plugins.GitHub.public

Default value: True

Determines whether this plugin is publicly visible.