webhook-exec

WebHook Server that execute commands directly from your packages.json

Usage no npm install needed!

<script type="module">
  import webhookExec from 'https://cdn.skypack.dev/webhook-exec';
</script>

README

webhook-exec

Build Status npm version npm downloads dependencies greenkeeper

A lightweight WebHook Server that execute commands defined directly on your packages.json file, how?

{
  "scripts": {
    "start-webhook": "webhook-exec --port 1234 --secret 123456 --server gogs",
    "stop-webhook": "webhook-exec stop"
  },
  "webhooks": {
    "push": [
      "git pull",
      "npm install",
      "npm run build"
    ],
    "delete": "rm -rf . && echo 'bye-bye'"
  }
}

You can find a list of events that you can react to here https://developer.github.com/webhooks/#events

Install

$ npm install webhook-exec -D

Options

Options type default description
host string localhost The host address which the webhook will be listening for data
port number 7070 The host port number
secret string - A secret key shared with your webhook client/server
server string github one of github, gogs, gitlab, bitbucket

Commands

stop stop the server. example:

webhook stop

License

MIT © Rafael Milewski