Github Web Hook Listener

npm install git-fish
6 downloads in the last week
12 downloads in the last month

Github Web Hook Listener in Node.js

Why fish? What recieves a hook?


$ gitfish help
Usage: gitfish [forever options] action

 Gitfish Actions

   config   build initial config file
   start    start gitfish
   help     show this message

 Daemonized Actions

   stop     stop gitfish (when daemonized)
   restart  restart gitfish (when daemonized)
   status   status of gitfish (when de

 Optional Gitfish Options

   --daemonize : start gitfish daemonized
   --config    : default is `$CWD/config.json`
   --port      : overide port from config
   --token     : overide token from config

 Supported Forever Options

   --logFile [file] : forever log file location # default: /tmp/gitfish.log
   --outFile [file] : stdout file location      # default: forever log file
   --errFile [file] : stderr file location      # default: forever log file
   --pidFile [file] : pid file location         # default: /tmp/
   --max     [n]    : max restarts on error
   --plain          : disable command line colors
   --verbose        : verbose forever output

 What is forever?

Usage Examples

$ npm install git-fish

$ gitfish config
Listener port? [8000]
Security token? [secret]
Hook endpoint? [script] /foo
Hook script? [CWD/script.js]
Hook branch filter?
Saved configuration to /home/jmervine/config.json

$ cat config.json
  "port": 8000,
  "token": "secret",
  "foo": {
    "script": "/home/jmervine/script.js"

Configuration note:

script can be anything; ruby, bash, python, etc. It doesn't have to be a node script.

Real World Config Example

Important Note:

script path must absolute and the script must be executable.

  "port": 8001,
  "token": "shhh_do_not_tell_anyone",
  "prod": {
    "script": "/home/me/",
    "branch": "master" // optional branch matcher
  "dev": {
    "script": "/home/me/",
    "branch": "develop" // optional branch matcher

Where /home/me/ is something like:

#!/usr/bin/env bash
cd /path/to/mysite
git checkout master
git pull

And your post commit hooks would be:

npm loves you