Git push deployment in 7 easy steps.md

How-to setup a simple git push deployment

These are my notes basically. I first created this just as a reminder for myself. Feel free to use this for your project as a starting point.

On the server (example.com)

1. Create a user on example.com, as which we (the git client) connects (push) to exmaple.com.

sudo useradd -m -s /usr/bin/git-shell git

2. Add your ssh public key to the authorized_keys file of the created user:

sudo -u git bash
cd ~
mkdir -p .ssh
vim .ssh/authorized_keys
# Paste your public key and save

3. Create a git bare repo for your project:

mkdir testapp
cd testapp
git init --bare

4. Copy the post-receive script from this gist to the hooks dir of the created bare repo.

vim testapp/hooks/post-receive
# Paste the contents of post-receive from this gist
chmod +x testapp/hooks/post-receive

5. Set ownership and permissions of the DEPLOY_ROOT directory:

sudo chown root:git -R /var/www
sudo chmod 775 /var/www

6. (Optional) Add a systemd service file for your app. If you are using systemd, you can use the testapp.service file from this gist. Make sure you name it like your repository, so the post-receive hook can automatically find and restart your app.

On the client

7. Create a git repo and add our newly created remote:

mkdir testapp
cd testapp
git init
git remote add production [email protected]:~/testapp

8. Commit and push to production:

$ vim Makefile
$ # Paste contents of Makefile from this gist (as an example)
$ git add .
$ git commit -am "test commit"
$ git push production master
Counting objects: 12, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (4/4), done.
Writing objects: 100% (4/4), 432 bytes | 0 bytes/s, done.
Total 4 (delta 2), reused 0 (delta 0)
remote: +++++++++++++++++++++++ Welcome to 'example.com' (1.2.3.4) ++++++++++++++++++++++++
remote: 
remote: githook: I will deploy 'master' branch of the 'testapp' project to '/var/www/testapp'
remote: 
remote: githook: UPDATE (CMD: 'cd "${DEPLOY_TO}" && make "update"'):
remote: Makefile: Doing UPDATE stuff like grunt, gulp, rake,...
remote: git
remote: /var/www/testapp
remote: 
remote: githook: RESTART (CMD: 'sudo systemctl restart "${PROJECT_NAME}.service" && sudo systemctl status "${PROJECT_NAME}.service"'):
remote: testapp.service - node.js testapp
remote:    Loaded: loaded (/etc/systemd/system/testapp.service; disabled)
remote:    Active: inactive (dead) since Fri 2014-03-21 22:10:23 UTC; 10ms ago
remote:   Process: 9265 ExecStart=/bin/bash -c sleep 3;echo "I am starting";echo "$(whoami)"; (code=exited, status=0/SUCCESS)
remote: 
remote: Mar 21 22:10:20 image systemd[1]: Starting nodejs testapp...
remote: Mar 21 22:10:23 image testapp[9265]: I am starting
remote: Mar 21 22:10:23 image testapp[9265]: www-data
remote: Mar 21 22:10:23 image systemd[1]: Started node.js testapp.
remote: 
remote: ++++++++++++++++++++ See you soon at 'example.com' (1.2.3.4) ++++++++++++++++++++++
To [email protected]:~/testapp
   08babc4..95cabcc  master -> master

$

9. Repeat: Develop, commit and push :) Congratulations, you just setup git push deployment with automated build and service restart

Makefile

all:
	@echo "Doing all"

deploy:
	@echo "Pushing to production"
	@git push [email protected]:~/testapp master

update:
	@echo "Makefile: Doing UPDATE stuff like grunt, gulp, rake,..."
	@whoami
	@pwd

post-receive

#!/bin/bash
#
# Author: "FRITZ Thomas" <[email protected]> (http://www.fritzthomas.com)
# GitHub: https://gist.github.com/thomasfr/9691385
#
# The MIT License (MIT)
#
# Copyright (c) 2014 FRITZ Thomas
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#


# Received branch will be checked against this. Only deploy when receiving this branch.
DEPLOY_BRANCH="master"

# This is the root deploy dir.
DEPLOY_ROOT="/var/www"

# This will be 'eval'ed after git checkout -f step.
# Use this to call your build/update script or run make, grunt, gulp, etc.
# If empty or not set this step gets ignored.
UPDATE_CMD='cd "${DEPLOY_TO}" && make "update"'

# Command gets executed after 'UPDATE_CMD' has finished. Use this to restart running services
# or daemons. If empty or unset this step gets ignored.
RESTART_CMD='sudo systemctl restart "${PROJECT_NAME}.service" && sudo systemctl status "${PROJECT_NAME}.service"'


###########################################################################################

export GIT_DIR="$(cd $(dirname $(dirname $0));pwd)"
export PROJECT_NAME="${GIT_DIR##*/}"
export DEPLOY_TO="${DEPLOY_ROOT}/${PROJECT_NAME}"
export GIT_WORK_TREE="${DEPLOY_TO}"
IP="$(ip addr show eth0 | grep 'inet ' | cut -f2 | awk '{ print $2}')"


echo "+++++++++++++++++++++++ Welcome to '${HOSTNAME}' (${IP}) ++++++++++++++++++++++++"
echo

# Make sure directory exists. Maybe its deployed for the first time.
mkdir -p "${DEPLOY_TO}"

# Loop, because it is possible to push more than one branch at a time. (git push --all)
while read oldrev newrev refname
do

	branch=$(git rev-parse --symbolic --abbrev-ref $refname)

	if [ "${DEPLOY_BRANCH}" == "$branch" ]; then
		# Make sure GIT_DIR and GIT_WORK_TREE is correctly set and 'export'ed. Otherwhise
		# these two environment variables could also be passed as parameters to the git cli
		echo "githook: I will deploy '${DEPLOY_BRANCH}' branch of the '${PROJECT_NAME}' project to '${DEPLOY_TO}'"
		git checkout -f

		if [ ! -z "${UPDATE_CMD}" ]; then
			echo
			echo "githook: UPDATE (CMD: '${UPDATE_CMD}'):"
			eval $UPDATE_CMD
		fi

		if [ ! -z "${RESTART_CMD}" ]; then
			echo
			echo "githook: RESTART (CMD: '${RESTART_CMD}'):"
			eval $RESTART_CMD
		fi
		
	else
		echo "githook: I am NOT going to deploy the '${branch}' branch of the '${PROJECT_NAME}' project. Expected branch to deploy is '${DEPLOY_BRANCH}'."
	fi

done

echo
echo "++++++++++++++++++++ See you soon at '${HOSTNAME}' (${IP}) ++++++++++++++++++++++"
exit 0

testapp.service

[Unit]
Description=node.js testapp
Requires=network.target
After=network.target

[Service]
WorkingDirectory=/var/www/testapp
Type=forking

ExecStart=/bin/bash -c 'sleep 3;echo "I am starting";echo "$(whoami)";'
# For a node.js app this could be something like:
#ExecStart=/bin/bash -c 'npm start'

StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=testapp
User=www-data
Group=www-data

Environment="NODE_ENV=production" "DEBUG=testapp:*"

[Install]
WantedBy=multi-user.target