wooshell/gh-notifier

Tracks github projects to let you know when new releases are available.

dev-master 2013-08-03 08:46 UTC

Requires

• knplabs/github-api: *
• swiftmailer/swiftmailer: 5.1.*@dev
• symfony/console: 2.2.*
• symfony/yaml: 2.3.*
• wooshell/store-notifier: dev-master

MIT

• William Garcia

• store
• github
• notification

README

Tracks github projects to let you know when new releases are available.

Notifications modes:

• mail (mode: "swiftMailer")
• desktop notification (mode: "gnu")

Prerequisites

• notify-send for gnu mode

Installation

$ composer install

Configuration

$ src/wooshell/ghnotifier/Resources/config/notify.yml

Usage

Use this command to send notifications:

$ bin/gh-notifier send gnu,mail
$ bin/gh-notifier send gnu
$ ..

In the background, an history file is stored for each github project and at each run, the script detects new releases via Github API.

Notification modes values are comma separated

Running automatically

Lock each run of gh-notifier if you want to cronify the script. The lock file is removed at the end of a run.

$ bin/gh-notifier send gnu --lock-file=/tmp/gh-notifier.lock

You can build a PHAR if you need an easy way to deploy (needs box.phar installation from https://github.com/kherge/Box ):

$ build box
$ chmod +x gh-notifier.phar
$ gh-notifier.phar send [...]