a simple github post-receive hook
This is a very simple, easy to use evented web hook API for github or gitlab. A command-line executable is also available.
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';// if you'd like to programmatically stop listening// github.stop();
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 and you're done!
Available options are:
You can use the command-line client to execute a shell script when a particular event occurs.
Install it globally:
$ npm install -g node-github-hook
Then you can run
$ githubhook --helpUsage:githubhook [--host=HOST] [--port=PORT] [--callback=URL_PATH] [--secret=SECRET] [--verbose] <trigger> <script>Options:--host=HOST Address to listen on--port=PORT Port to listen on--callback=URL_PATH The callback URL path--secret=SECRET The secret you use the in the Github webhook config--verbose Log to console--version Output the version number-h, --help Output usage information
Default values for options are same as for the API (see above).
$ githubhook push:node-github-hook ./some_script.sh