gad </path/to/repo> [</path/to/post-deploy.sh>]
github-auto-deploy runs a small node webserver that responds to deployment requests from Github and updates the local repository.
A post-deploy script can also be used to finish a deployment after code has been updated.
PORT=1234 SECRET="Swifty4Lyfe" gad /var/app /var/app/bin/deploy.sh
The webserver can be configured with some environmental variables.
PORT- The port that the server runs on. Default: 3420
SECRET- The webhook secret. Default: none
On Github, you'll need to:
- Add a 'Github Auto-Deployment' service.
- Add a webhook that fires on 'deployment' events.
- If the repo is private, add a deploy key.
Note: By default, the Github Auto-Deployment service will create deployments every time code is pushed to
master, but can also be configured to deploy on status contexts, like
- Why are you using the
- The deployment event lets us deploy on status, like
ci/travis-ci, which means we can require tests to pass before a deploy will run.
- Why are you using
- We want all changed files to be updated on the server as close to the same time as possible to avoid serving some old and some new files for a given request. Another approach is using symlinks and moving file pointers around.