NAME

       github-notifier  - companion script for git-notifier, that watches GitHub repositories for
       changes

SYNOPSIS

       github-notifier [options]

DESCRIPTION

       github-notifier is a companion script for git-notifier, that watches  GitHub  repositories
       for  changes.  The  script  maintains a local mirror of repositories you want to watch and
       runs git-notifier locally on those to generate the notification mails.

       To setup github-notifier you  create  a  configuration  file  github-notifier.cfg  in  the
       directory  where  you  want to keep the clones. github-notifier.cfg is an "ini-style" file
       consisting of one or more sections, each  of  which  defines  a  set  of  repositories  to
       monitor, see below its description.

       For full documentation, see the homepage at: http://www.icir.org/robin/git-notifier/.

OPTIONS

       --allchanges <branches>
              --config=PATH PATH to alternative configuration file.

       --debug
              Run  the  script in debug mode, which means that it will (1) log more verbosely and
              to stderr, and (2) run git-notifier with the --debug and --noupdate options.

FILES

       github-notifier.cfg
              The file should be placed in the directory where you want to keep the clones

       Specifying Repositories

              The repositories entry takes a list of command-separated repositories  to  monitor.
              Each  repository  has  the  form  <user>/<repo>,  where <user> is a GitHub user (or
              organization) and <repo> is a repository that the user (or organization) maintains.
              <repo>  can  be  the  wildcard  *  to  monitor  all of a user's repositories (e.g.,
              repositories=bro/*). One can exclude individual repositories by prefixing them with
              a dash (e.g., repositories=bro/*,-bro/time-machine).

       Authentication

              By default, github-notifier only monitors public repositories. You can however also
              watch private ones if you provide it with suitable credentials using the  user  and
              token options:

              user=foo

              token=3238753465abc7634657zefg

              The token shouldn't be the user's password but a "personal access token" as you can
              generate it in the user's account settings.

       Setting Notifier Options

              Within a set one can specify any of the standard git-notifier options by  prefixing
              them  with  notifier-.  The  notifier-mailinglist  options above is an example. To,
              e.g., set a Reply-To header, you would use notifier-replyto=somebody@else.net.

EXAMPLES

       Here's an example set that  watches  just  a  single  repository  at  github.com/bro/time-
       machine:

       [TimeMachine]

       repositories=bro/time-machine

       notifier-mailinglist=foo@bar.com

       This  defines  a  set  called  TimeMachine  consisting  of just the one GitHub repository,
       sending notifications to the given email address. With this saved in the current directory
       as  github-notifier.cfg,  you  can  then run github-notifier and it will create a complete
       clone of the remote on its  first  run  (and  not  send  any  mails  yet).  On  subsequent
       executions,  the  script  will  update  the  clone  and  spawn  git-notifier  to email out
       notifications. For now, the best way to automate this is to run github-notifier from cron.

BUGS

       Report bugs on https://github.com/rsmmr/git-notifier/issues

SEE ALSO

       git(1), git-notifier(1)

LICENSE

       git-notifier comes with a BSD-style license.

AUTHOR

       Robin   Sommer   <robin@icir.org>.   This   manpage   is   written   by    Lev    Lamberov
       <l.lamberov@gmail.com>.

                                                                               GITHUB-NOTIFIER(1)