Using Git Hooks To Automate Development and Deployment
mkdocs example
Create your directory structure(s)
Local development and testing
mkdir ~/projects/sites/www.universalcake.local
For a production site
mkdir -p ~/projects/sites/www.universalcake.com/mkdocs
cd ~/projects/sites/www.universalcake.com/mkdocs
git init
output exanmple:
Initialized empty Git repository in /home/cjs/projects/sites/www.universalcake.com/mkdocs/.git/
hooks
Lets take a look at the hook samples
cd .git/hooks
ls -l
Output:
total 52
-rwxr-xr-x 1 cjs cjs 478 Feb 26 15:54 applypatch-msg.sample
-rwxr-xr-x 1 cjs cjs 896 Feb 26 15:54 commit-msg.sample
-rwxr-xr-x 1 cjs cjs 3079 Feb 26 15:54 fsmonitor-watchman.sample
-rwxr-xr-x 1 cjs cjs 189 Feb 26 15:54 post-update.sample
-rwxr-xr-x 1 cjs cjs 424 Feb 26 15:54 pre-applypatch.sample
-rwxr-xr-x 1 cjs cjs 1638 Feb 26 15:54 pre-commit.sample
-rwxr-xr-x 1 cjs cjs 416 Feb 26 15:54 pre-merge-commit.sample
-rwxr-xr-x 1 cjs cjs 1492 Feb 26 15:54 prepare-commit-msg.sample
-rwxr-xr-x 1 cjs cjs 1348 Feb 26 15:54 pre-push.sample
-rwxr-xr-x 1 cjs cjs 4898 Feb 26 15:54 pre-rebase.sample
-rwxr-xr-x 1 cjs cjs 544 Feb 26 15:54 pre-receive.sample
-rwxr-xr-x 1 cjs cjs 3610 Feb 26 15:54 update.sample
Notice that each of these files are marked executable and that each file ends in .sample.
These scripts are called (executed) by name so the first line must be a shebang reference to call the correct script interpreter:
#! /bin/sh – Execute the file using the Bourne or compatible shell in the /bin directory
#! /bin/bash – Execute using the Bash shell
#! /usr/bin/pwsh – Execute using PowerShell
#! /usr/bin/env python3 – Execute with a Python interpreter, using the env program search path to find it
#! /bin/false - Do nothing, but return a non-zero exit status, indicating failure
Other script languages can be use, three common ones include bash, perl and python
files that end in .sample come with git but are not executed as git simply looks at the filename (not the extension) when trying to find hook files to execute.
So rename a script something else like update.test "disables" the script. If you wanted to enable any of the scripts in this directory, you would have to remove the .sample suffix.
Deploying to a local web server
Here we will use a post-commit hook to deploy to a local server
ExampleRequirements
sudo apt-get update
sudo apt-get install apache2
Deluxe File Layout example
This directory structure would allow for the hosting of multiple websites. Here we are going to focus on public_html directory for universalcake.com
/var/www/
├── www.universalcake.com/
│ ├── public_html/ # Web root for the site (DocumentRoot)
│ ├── logs/ # Access and error logs (optional)
│ ├── backups/ # Site backups (optional)
│ ├── ssl/ # SSL certificates (if storing locally)
│ ├── config/ # Site-specific configs (optional)
│ ├── tmp/ # Temporary files (optional)
│ ├── sessions/ # PHP session files (optional)
│ └── private/ # Private files outside web root
│
└── shared/ # Optional shared assets (e.g., images, scripts, static files)
Create directory(ise)
sudo mkdir -p /var/www/universalcake.com/public_html
Setting up permissions:
sudo chown -R `whoami`:`id -gn` /var/www/universalcake.com/public_html
sudo chown -R `whoami`:`id -gn` /var/www/www.universalcake.com/public_html
Confirmation
ls -al /var/www/www.universalcake.com/public_html
Site project directory
you can manually add an index.html to your website projects root directory. In this case we are going to use mkdocs to do this for us.
cd ~/projects/sites/www.universalcake.com/mkdocs
we will be using an venv so we will start this in order to use mkdocs:
mkdocs-static-i18n-1.2.3
now we will initialize our site in our sites mkdocs directory
mkdocs new .
Next we build the default site so that we have files in our projects git repository
mkdocs build
Add the new file to tell git to track the file:
git add .
Running git status
git status
Output:
On branch master
No commits yet
Changes to be committed:
(use "git rm --cached <file>..." to unstage)
new file: docs/index.md
new file: mkdocs.yml
new file: site/404.html
...
Before we commit we are going to create a post-commit hook for the repository. Create this file within the .git/hooks directory for the project:
nano .git/hooks/post-commit
content example
#!/bin/bash
source ~/.venv/mkdocs-static-i18n-1.2.3/bin/mkdocs
mkdocs build
unset GIT_INDEX_FILE
git --work-tree=/var/www/www.universalcake.com/public_html --git-dir=$HOME/projects/sites/www.universalcake.com/mkdocs/site checkout -f
Notes:
environmental variables that are set each time the post-commit hook is called. In particular, GIT_INDEX_FILE is set to .git/index. This path is in relation to the working directory, which in this case is /var/www/www.universalcake.com/public_html.
Since the git index does not exist at this location, the script will fail if you leave it as-is. To avoid this situation, you can manually unset the variable.
Then we use git itself to unpack the newest version of the repository after the commit, into your web directory.
You will want to force this transaction to make sure this is successful each time.
Make your git hook executable
chmod +x .git/hooks/post-commit
Test Commit
git commit -m 'initial commit test'
Output
import-im6.q16: attempt to perform an operation not allowed by the security policy `PS' @ error/constitute.c/IsCoderAuthorized/413.
import-im6.q16: attempt to perform an operation not allowed by the security policy `PS' @ error/constitute.c/IsCoderAuthorized/413.
from: can't read /var/mail/mkdocs.__main__
/home/cjs/.venv/mkdocs-static-i18n-1.2.3/bin/mkdocs: line 7: syntax error near unexpected token `('
/home/cjs/.venv/mkdocs-static-i18n-1.2.3/bin/mkdocs: line 7: ` sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])'
INFO - Cleaning site directory
INFO - Building documentation to directory: /home/cjs/projects/sites/www.universalcake.com/mkdocs/site
INFO - Documentation built in 0.06 seconds
fatal: not a git repository: '/home/cjs/projects/sites/www.universalcake.com/mkdocs/site'
[master (root-commit) 142f356] initial test commit
31 files changed, 4806 insertions(+)
create mode 100644 docs/index.md
create mode 100644 mkdocs.yml
create mode 100644 site/404.html
create mode 100644 site/css/base.css
...
create mode 100644 site/webfonts/fa-v4compatibility.woff2