a simple github post-receive hook
This is a very simple, easy to use evented web hook for github.
npm install githubhook
var githubhook = require'githubhook';var github = githubhook/* options */;githublisten;githubon'*';githubon'event';githubon'event:reponame';githubon'event:reponame:ref';githubon'reponame';githubon'reponame:ref';
Where 'event' is the event name to listen to (sent by github, typically 'push'), 'reponame' is the name of your repo (this one is node-github-hook), and 'ref' is the git reference (such as ref/heads/master)
Configure a WebHook URL to whereever the server is listening, with a path of
/github/callback?secret=yoursecret if you set a secret) and you're done!
Available options are:
- host: the host to listen on, defaults to '0.0.0.0'
- port: the port to listen on, defaults to 3420
- path: the path for the github callback, defaults to '/github/callback'
- secret: if specified, you must use the same secret in your webhook configuration in github. if a secret is specified, but one is not configured in github, the hook will fail. if a secret is not specified, but one is configured in github, the signature will not be validated and will be assumed to be correct. consider yourself warned.
- logger: an optional instance of a logger that supports the "log" and "error" methods and one parameter for data (like console), default is to not log. mostly only for debugging purposes.