GitHub Webhooks Listener

A simple listener that will trigger custom scripts when it receives events from GitHub.

Usage

$ git clone git@github.com:suhay/github-webhooks-listener.git
$ cd github-webhooks-listener
$ python setup.py install --user

.env file

API_TOKEN=YOUR_GITHUB_SECRET

Repo configuration files

.
├── README.md
└── sites
    └── my-site.json

my-site.json

{
  "path": "/home/code/my-site", // path where repository lives
  "cwd": "/home/user", // user path for nvm
  "node": "v12.7.0", // nvm node version to use, if .nvmrc is no supplied
  "release": {
    "build": "yarn && yarn build && tar -xvf {{release.sha}}.tar.gz", // you may use handlebar notation to inject GitHub payload values into your steps
    "deploy": "rsync -av --delete public/ /var/www/html/my-site",
    "cleanup": "rm -rf node_modules/ && rm -rf .cache/ && yarn cache clean"
  }
}

Adding listener to GitHub Webhooks

As of v0.2.2 - Only the release event is supported.

https://{domain}/webhooks/{repo}
or
https://yoursite.com/webhooks/my-site

The repo name must match the repository name (minus the user/org name) sent from GitHub and also the respective .json file that contains its custom scripts.

Deploying with Hypercorn

$ sudo nano /etc/systemd/system/github-webhooks-listener.service

[Unit]
Description=GitHub Webhooks Listener
After=network.target
StartLimitIntervalSec=0

[Service]
Type=simple
Restart=always
RestartSec=1
User=ubuntu
ExecStart=/home/ubuntu/.local/bin/hypercorn /mnt/projects/github-webhooks-listener/src/app --bind 127.0.0.1:5000

[Install]
WantedBy=multi-user.target

Within your Apache2 .conf

ProxyPass /webhooks http://localhost:5000/webhooks
ProxyPassReverse /webhooks https://localhost:5000/webhooks