snoopaloop / supybot-git Goto Github PK

Supybot Git Plugin
==================

This (like most Supybot plugins, probably) falls into the category of
scratching an itch.  I wanted an IRC bot to notify me of commits to git
repositories, didn't find a suitable plugin for Supybot, and wrote this.

It is general purpose and should work for most people, but it is in a fairly
immature state, so you can still shoot yourself in the foot with it, probably.

Dependencies
------------

This plugin depends on the GitPython package (in Debian/Ubuntu: apt-get
install python-git), which in turn depends on git.  It will not function
without them.

Configuration
-------------

The Git plugin has a few standard configuration settings, but the primary
configuration - where the repositories are defined - lives in an INI file.
By default, it will look for the file 'git.ini' where you run Supybot.  You
can override this with "config plugins.Git.configFile /path/to/file".

Here is an example of a repository definition:

    [Prototype]
    short name = prototype
    url = https://github.com/sstephenson/prototype.git
    commit link = https://github.com/sstephenson/prototype/commit/%c
    channel = #prototype

Most of this will be self-explanatory.  This defines a repository for the
Prototype Javascript library, so the Git plugin will be able to fetch a copy
of it and display commits as they happen.

Let's break down the possible settings:

short name:     Required. This is the nickname you use in all commands that
                interact with the repository.

url:            Required. The URL to the git repository, which may be a path
                on disk, or a URL to a remote repository.

channel:        Required. The channel where the repository messages will
                appear.  This is also a weak privacy measure; people on other
                channels will not be able to request information about the
                repository. All interaction with the repository is bound to
                this one channel.

branch:         Optional. The branch to follow for this repository. If you
                want to follow multiple branches, you need to define multiple
                repository sections with different nicknames.
                Default: master.

commit link:    Optional. A format string describing how to link to a
                particular commit. These links may appear in commit
                notifications from the plugin.  Two format specifiers are
                supported: %c (7-digit SHA) and %C (full 40-digit SHA).
                Default: nothing.

commit message: Optional. A format string describing how to describe commits
                in the channel.  See Commit Messages below for detail.
                Default: [%s|%b|%a] %m

Commit Messages
---------------

Commit messages are produced from a general format string that you define.
It uses the following substitution parameters:

    %a       Author name
    %b       Branch being watched
    %c       Commit SHA (first 7 digits)
    %C       Commit SHA (entire 40 digits)
    %e       Author email
    %l       Link to commit
    %m       Commit message (first line only)
    %n       Name of repository (config section heading)
    %s       Short name of repository
    %u       Git URL for repository
    %(fg)    IRC color code (foreground only)
    %(fg,bg) IRC color code (foreground and background)
    %!       Toggle bold
    %%       A literal percent sign.

The format string can span multiple lines, in which case, the plugin will
output multiple messages per commit.  Here is a format string that I am
partial to:

    commit message = %![%!%(14)%s%(15)%!|%!%(14)%b%(15)%!|%!%(14)%a%(15)%!]%! %m
                     View%!:%! %(4)%l

As noted above, the default is a simpler version of this:

    commit message = [%s|%b|%a] %m

Leading spaces in any line of the message are discarded, so you can format it
nicely in the file.  I wouldn't be surprised if you find something that
doesn't work quite right here - all combinations have not been tested, and
people are not terribly consistent in the way they format their author name,
email address, commit messages, etc.

Configurable Values
-------------------

As mentioned above, there are a few things that can be configured within the
Supybot configuration framework.  For relative paths, they are relative to
where Supybot is invoked.  If you're unsure what that might be, just set them
to absolute paths.  The settings are found within supybot.plugins.Git:

configFile: Path to the INI file.
            Default: git.ini

repoDir:    Path where local clones of repositories will be kept.  This is a
            directory that will contain a copy of all repository being tracked.
            Default: git_repositories

pollPeriod: How often (in seconds) that repositories will be polled for
            changes.  Zero disables periodic polling.
            Default: 120

How Notification Works
----------------------

The first time a repository is loaded from the INI file, a clone will be
performed and saved in the repoDir defined above.

    Warning #1: If the repository is big and/or the your network is slow, the
    first load may take a very long time!

    Warning #2: If the repositories you track are big, this plugin will use a
    lot of disk space for its local clones.

After this, the poll operation involves a fetch (generally pretty quick), and
then a check for any commits that arrived since the last check.

Repository clones are never deleted. If you decide to stop tracking one, you
may want to go manually delete it to free up disk space.

Command List
------------

gitrehash: Reload the INI file, cloning any newly present repositories.
           Restarts any polling if applicable.

repolist:  List any known repositories configured for the current channel.

shortlog:  Takes a repository nickname (aka "short name") and an optional
           count parameter (default 1).  Shows the last n commits on the
           branch tracked for that repository.  Only works if the repository
           is configured for the current channel.