Add support for the "push" event

In addition to executing a script when a new release is published, add the ability to execute another script whenever a push occurs on the default branch

Author: jessety

.env.defaults

@@ -1,4 +1,17 @@
-SECRET=
-SCRIPT=
+# Port to run the server on
 PORT=number=32490
+
+# GitHub WebHook secret (required)
+SECRET=
+
+# Script to execute when a release is published
+SCRIPT_RELEASE=
+
+# Script to execute when a push occurs in the default branch
+SCRIPT_PUSH=
+
+# Name of the default branch, if it isn't `main` or `master`
+DEFAULT_BRANCH=
+
+# Whether to print out all events
 VERBOSE=boolean=false

README.md

@@ -1,6 +1,6 @@
 # github-webhook
 
-A minimal GitHub webhook listener that executes a specified command when a release is published.
+A minimal GitHub webhook listener that executes a script when a push event occurs on the default branch, or when a release is published.
 
 [![ci](https://github.com/jessety/github-webhook/workflows/ci/badge.svg)](https://github.com/jessety/github-webhook/actions)
 
@@ -9,25 +9,48 @@ A minimal GitHub webhook listener that executes a specified command when a relea
 ```bash
 git clone ...
 cd github-webhook
+
 npm install --production
 pm2 start ecosystem.config.json
 ```
 
 ## Configuration
 
-Edit an `.env` file in the project directory with the following options:
+Populate an `.env` file in the project directory with the following options:
 
 ```ini
-# GitHub Webhook Secret
+# GitHub Webhook Secret (required)
 SECRET=ABC123
 
 # Script to execute when a release is published
-SCRIPT=/usr/bin/local/update.sh
+SCRIPT_RELEASE=/usr/local/bin/release.sh
+
+# Script to execute when there is a push to the default branch
+SCRIPT_PUSH=/usr/local/bin/push.sh
+
+# Name of the default branch, if it isn't "main" or "master"
+DEFAULT_BRANCH=primary
 
 # Port to run the server on
 PORT=32490
 ```
 
+## Scripts
+
+Scripts are executed with the name of the repository as the first parameter, and the event type as the second.
+
+Push events are only triggered when a push is made to the default branch. The script is executed with the name of that branch as its third parameter. Given the above configuration, the following will be executed a push is made to the `primary` branch:
+
+```bash
+/usr/local/bin/push.sh jessety/github-webhook push primary
+```
+
+When a release is triggered, the release tag is sent as a third parameter:
+
+```bash
+/usr/local/bin/release.sh jessety/github-webhook release v1.1.4
+```
+
 ## License
 
 MIT © Jesse Youngblood

src/index.js

@@ -16,18 +16,20 @@ const webhook = new WebHook(options);
 
 webhook.on('error', error => console.error(error));
 
-// If verbose mode is enabled, print out every event we receive
+// If verbose mode is enabled, log out every event
 
 if (options.verbose === true) {
 
+  console.log(`Verbose mode enabled, logging all incoming events.`);
+
   webhook.onAny((event, payload) => {
 
     const { repository, action } = payload;
     console.log(`${new Date().toLocaleString()} - ${repository.full_name}: ${event} ${action ? `${action}` : ''}`);
   });
 }
 
-// When a release is published, execute the update script
+// When a release is published, execute the 'release' script
 
 webhook.on('release', payload => {
 
@@ -39,10 +41,41 @@ webhook.on('release', payload => {
 
   console.log(`\n\n${new Date().toLocaleString()} - ${repository.full_name} ${release.tag_name} ${action}`);
 
-  execute(options.script, repository.full_name);
+  if (options.script_release === '') {
+    return;
+  }
+
+  execute(options.script_release, repository.full_name, 'release', release.tag_name);
+});
+
+// When a push event occurs on the default branch, execute the 'push' script
+
+webhook.on('push', payload => {
+
+  const branch = payload.ref.replace('refs/heads/', '');
+
+  const defaultBranchNames = ['main', 'master'];
+
+  if (options.default_branch !== '' && defaultBranchNames.includes(options.default_branch) === false) {
+    defaultBranchNames.push(options.default_branch);
+  }
+
+  if (defaultBranchNames.includes(branch) === false) {
+    return;
+  }
+
+  const { repository } = payload;
+
+  console.log(`\n\n${new Date().toLocaleString()} - ${repository.full_name} push ${branch}`);
+
+  if (options.script_push === '') {
+    return;
+  }
+
+  execute(options.script_push, repository.full_name, 'push', branch);
 });
 
-// Listen for incoming events
+// Start listening for incoming events
 
 webhook.listen().then(() => {