Moritz Martinius
d3e137ff9c
All checks were successful
Build ptprnt / build (push) Successful in 3m52s
Reviewed-on: moritz/ptouch-prnt#18
44 lines
905 B
Markdown
44 lines
905 B
Markdown
# Git Hooks
|
|
|
|
This directory contains git hooks for the ptprnt repository.
|
|
|
|
## Installation
|
|
|
|
To install the hooks, run:
|
|
|
|
```bash
|
|
./hooks/install_hooks.sh
|
|
```
|
|
|
|
This will copy all hooks from this directory to `.git/hooks/` and make them executable.
|
|
|
|
## Available Hooks
|
|
|
|
### pre-commit
|
|
|
|
The pre-commit hook automatically updates copyright headers in source files before each commit.
|
|
|
|
**What it does:**
|
|
- Runs `scripts/update_copyright.sh` to update copyright years in source files
|
|
- Automatically re-stages any modified files
|
|
- Ensures copyright headers are always up-to-date
|
|
|
|
**Requirements:**
|
|
- `scripts/update_copyright.sh` must exist and be executable
|
|
|
|
## Skipping Hooks
|
|
|
|
If you need to skip the pre-commit hook for a specific commit (not recommended), use:
|
|
|
|
```bash
|
|
git commit --no-verify
|
|
```
|
|
|
|
## Uninstalling
|
|
|
|
To remove a hook, simply delete it from `.git/hooks/`:
|
|
|
|
```bash
|
|
rm .git/hooks/pre-commit
|
|
```
|