Simple GitHub/Bitbucket Webhook deployments (with Slack integration 🎉)
Any of the following:
- Python 2.7
- Python 3.6
- Docker
Does this look familiar?
$ git commit -am "FIYAAA :fire:"
$ ssh dev
$ cd /var/www/my-project
$ git pull origin develop
$ [touch app.wsgi | cp -R dist/ public_html/ | ... ]
Woudn't it be nice if you could just commit, push and get notified in Slack once the change is deployed?
You will need to setup a Webhook that will get triggered every time you push a code change to GitHub / Bitbucket.
Skilled Hammer will then assume the privileges of the user that owns the folder and take care of pulling the latest changes and running any additional commands you have defined. Usual suspects include:
- compiling sass
- applying database migrations
- copying static files
- restarting services
NB! If you are running a containerized version of Skilled Hammer, make sure the command exists in the Docker container environment. See Dockerfile reference on how to modify it.
Go to the repository Settings, in the left side menu click on Webhooks and then click on Add webhook button.
The interesting bits here are:
- Payload URL - that's where
Skilled Hammeris listening on - Secret - this proves that request actually originated from GitHub's servers
Both need to be filled out!
Go to the repository Settings, in the secondary menu click on Webhooks and then click on Add webhook button.
Configuration is stored in repositories.conf and this is how an example entry would look like:
[vigilant-octo]
# the repository in question
origin = https://github.com/r00m/vigilant-octo
# working directory. this is where `git pull` and `command` are run from
directory = /var/www/vigilant-octo.org
# the command to run after a successfull `git pull`
command = compass compile
NB! If you are running a containerized version of Skilled Hammer, make sure the command exists in the Docker container environment. See Dockerfile reference on how to modify it.
It's quite easy:
docker run --restart=unless-stopped --name skilled-hammer \
-p "8000:8000" \
-e "HAMMER_SECRET=YOUR_SECRET_HERE" \
-v "$PWD/repositories.conf:/usr/src/app/repositories.conf" \
r00m/skilled-hammer
and navigate to http://localhost:8000, to see that it worked and GET method is not allowed 😅
Clone the repo, then install required packages using:
$ pip install -r requirements.txt
configure secrets:
$ export HAMMER_SECRET=YOUR_SECRET_HERE
and start the app:
$ gunicorn -b 0.0.0.0:8000 -w 4 --access-logfile=- wsgi:app
NB! You should always use virtual environments (venv's) when installing python packages, read on how and why.
Just add SLACK_HOOK environment variable to the docker run command:
docker run --restart=unless-stopped --name skilled-hammer \
-p "8000:8000" \
-e "HAMMER_SECRET=YOUR_SECRET_HERE" \
-e "SLACK_HOOK=YOUR_HOOK_URL_HERE" \
-v "$PWD/repositories.conf:/usr/src/app/repositories.conf" \
r00m/skilled-hammer
Configure secrets like this:
$ export HAMMER_SECRET=YOUR_SECRET_HERE \
SLACK_HOOK=YOUR_HOOK_URL_HERE
then start the app:
$ gunicorn -b 0.0.0.0:8000 -w 4 --access-logfile=- wsgi:app
NB! You should always use virtual environments (venv's) when installing python packages, read on how and why.
$ python tests.py
All incoming requests are validated according to GitHub's Webhook guidelines or Bitbucket's Event Payloads.
NB! For projects hosted on GitHub, always setup Secret when creating a Webhook, it provides additional layer of security.
MIT