pre-commit hook

Overview Git%20hooks are powerful, event-driven scripts that fire at specific points in the Git lifecycle. They serve as a local gatekeeper, allowing you to execute custom logic before or after actions like committing, pushing, or merging. By automating these checks, you ensure that every piece of code entering your repository meets your team's quality standards without relying on manual oversight. Prerequisites To follow this guide, you should have a basic understanding of the command line and Python syntax. You must have Git installed and initialized in your project directory. Key Libraries & Tools * Git: The version control system providing the hook architecture. * Python: Our scripting language of choice for writing logic. * GitHub%20Actions: A CI/CD alternative for heavy tasks. Code Walkthrough Git stores hooks in a hidden directory: `.git/hooks`. To create a custom pre-commit%20hook, follow these steps. 1. The Shell Entry Point Create a file named `pre-commit` (no extension) in `.git/hooks/`. This shell script acts as the bridge to our Python logic. ```bash #!/bin/sh python3 .git/hooks/pre-commit.py "$@" ``` The `$@` syntax is vital. It ensures that any arguments Git passes during the commit process propagate to your Python script. 2. The Python Logic Now, create `pre-commit.py` in the same directory. This script will inspect the commit attempt. ```python import sys def main(): # Print arguments passed by Git print(f"Arguments received: {sys.argv[1:]}") # Business logic here: check linting or formatting # To block the commit, exit with a non-zero code print("Validation failed: Please check your formatting.") sys.exit(1) if __name__ == "__main__": main() ``` Syntax Notes Git determines hook success based on **exit codes**. An exit code of `0` allows the operation to proceed, while any non-zero code (like `sys.exit(1)`) aborts the commit. This simple binary behavior makes it easy to integrate complex validation libraries. Practical Examples You can use these hooks to enforce **commit message policies**, prevent large binary files from being staged, or run lightweight unit tests. They are perfect for ensuring Python developers run `black` or `flake8` before their code ever leaves their machine. Tips & Gotchas Keep your local hooks lightweight. If a script takes more than a few seconds, it disrupts the developer's flow. For heavy tasks like comprehensive test suites or deep security scanning, move that logic to GitHub%20Actions. Local hooks are for speed; CI/CD is for depth.