Git Hooks and Automation

# CHAPTER 11

Git Hooks and Automation #

1. Introduction #

2. Learning Objectives #

• Define what a Git Hook is and where it resides in the repository.

• Differentiate between client-side and server-side hooks.

• Create an executable pre-commit hook.

• Create an executable commit-msg hook to enforce message standards.

• Bypass a hook locally using the --no-verify flag.

3. Beginner-to-Advanced Explanations #

The Solution (Git Hooks): A Git Hook is a robotic bouncer at the door of the Git database. You write a script (the pre-commit hook) and give it to the bouncer. The script says: "Scan the incoming files. If you see 'console.log', reject the commit." Now, when the junior developer types git commit, the bouncer instantly blocks the action on their local laptop, throwing a red terminal error before the commit is even created. The feedback is instantaneous.

4. Exploring the .git/hooks Directory #

cd .git/hooks
ls -la

You will see files like:

• pre-commit.sample

• commit-msg.sample

• pre-push.sample

To activate a hook, you simply rename the file (remove the .sample extension) and ensure the file has execution permissions on your operating system.

5. Mini Project: Build Automated Commit Checker #

Step-by-Step Walkthrough:

1. 1. Create a repository: mkdir hooks-demo && cd hooks-demo && git init

1. 2. Navigate to the hooks directory: cd .git/hooks

1. 3. Create the script file: touch pre-commit

1. 4. Make it executable: chmod +x pre-commit

1. 5. Open pre-commit in a text editor and paste this exact Bash script:

#!/bin/bash
# A simple pre-commit hook to reject console.log

# Check if 'console.log' exists in the files staged for commit
if git diff --cached | grep -q 'console.log'; then
    echo "ERROR: You left a console.log in your code!"
    echo "Please delete it before committing."
    exit 1 # Exit 1 tells Git to abort the commit!
fi

exit 0 # Exit 0 tells Git to allow the commit

1. 6. The Test: Go back to your main project folder.

   cd ../../
   echo "console.log('Testing');" > app.js
   git add app.js
   git commit -m "Add app.js"
   ```
7. *The Result:* Git instantly stops. The terminal prints your custom ERROR message in red. The commit fails. You have successfully automated local code quality!

### 6. Common Client-Side Hooks
- **`pre-commit`:** Runs immediately after typing `git commit`. Used to run linters, syntax checkers, and security scanners.
- **`commit-msg`:** Runs after you type your commit message. Used to enforce regex standards (e.g., ensuring every commit message starts with a Jira Ticket number like `[PROJ-123] Fixed bug`).
- **`pre-push`:** Runs right before you `git push`. Excellent for running a heavy unit test suite to ensure you don't push broken code to the shared repository.

### 7. The Escape Hatch
Sometimes, you absolutely must commit code that fails the hook (e.g., you are doing a temporary test). You can command Git to ignore the bouncer entirely.

bash git commit -m "Emergency fix" --no-verify `` *Warning: Overusing --no-verify defeats the entire purpose of the automation.*

• Share Your Hooks: The .git/hooks directory is completely ignored by version control. If you write a brilliant pre-commit hook, your coworkers will not get it when they clone the repo. The best practice is to store your scripts in a visible folder (like /.githooks) and write a setup script (npm install or a Makefile) that automatically symlinks those files into the hidden .git/hooks folder on your coworkers' laptops.

• Forgetting Executable Permissions: The number one reason a custom Git Hook "doesn't work" is that the developer forgot to run chmod +x pre-commit on Mac/Linux. If the file is not marked as an executable script by the operating system, Git will silently ignore it.

1. 1. Explain the architectural difference in execution timing between a pre-commit hook and a CI/CD pipeline on GitLab/GitHub.

13. Next Chapter Recommendation #