ramigs / netlify-lambda-github-webhook-router

Parsing GitHub's push Webhook to decide whether or not to trigger Netlify's build and deploy for a list of sites in a mono-repository

netlify-lambda-github-webhook-router

Netlify Lambda Function that listens to GitHub's push Webhook, verifying which sites/folders include file changes, and triggering Netlify's build hook only for those specific sites.

This is useful if you have a mono-repository with multiple sites, and would like to avoid unecessary builds and deploys being triggered for sites without changes.

Setup

To run the lambda function locally, here’s what you’ll need:

Clone the repo:

git clone https://github.com/ramigs/netlify-lambda-github-webhook-router
cd netlify-lambda-github-webhook-router

Install dependencies

npm install

List your sites and endpoints

Create and edit a file .env to specify the sites - and respective Netlify endpoints- included in the mono-repository.

Each site is describe by two env variables:

• SITE_1_FOLDER, the relative repository path of site 1
• SITE_1_NETLIFY_ENDPOINT, the URL of Netlify's build hook for site 1

Check .env_sample to see an example.

Build lambda function

npm run lambda-build

Run lambda function locally

npm run lambda-serve

Function will be listening at http://localhost:9000/webhookParser

Testing locally

You can send a POST request to http://localhost:9000/webhookParser , following the same request format of GitHub's Webhook.

If you send the following HTTP request, and you have 11-Custom-Video-Player site/folder added to your env variables, as well as its respective Netlify endpoint, the build and deploy will be triggered.

{
	"head_commit": {
		"added": ["11-Custom-Video-Player/f1.txt", "f2.txt"],
		"removed": ["f3.txt", "f4.txt"],
		"modified": ["f5.txt", "f6.txt"]
		
	}
}

Deploying function to Netlify

Create a new site on Netlify, and connect your function's repo to it.

Add sites and endpoints to Netlify

Through Netlify's UI, create your environment variables in your function's site, following the same format of .env.

PS: If you make changes to variables, a new build and deploy is required to force variables to be reloaded.

GitHub Webhook to Netlify function

Configure GitHub to send the push Webhook to the deployed function's Netlify endpoint.

Ask Netlify Support to disable automatic deploys

Request disabling of automatic deploys for all your sites in the mono-repository, while still maintaining the repo linked to Netlify, as mentioned here.

License

This project is open source and available under the MIT License.