Menu
How can I write a git hook that outputs a warning in the comment section if there have been no commits to CHANGELOG on the current branch ?
I would like to output something like:
# CHANGELOG Not updated.
#
# Update changelog before submitting PR.
#
291
The pre-commit hook is run first, before you even type in a commit message. It's used to inspect the snapshot that's about to be committed, to see if you've forgotten something, to make sure tests run, or to examine whatever you need to inspect in the code.
If you want to manually run all pre-commit hooks on a repository, run pre-commit run --all-files . To run individual hooks use pre-commit run <hook_id> . The first time pre-commit runs on a file it will automatically download, install, and run the hook. Note that running a hook for the first time may be slow.
Git hooks are scripts that run automatically every time a particular event occurs in a Git repository. They let you customize Git's internal behavior and trigger customizable actions at key points in the development life cycle.
If you want a local commit hook, you can add this script under .git/hooks/pre-commit
#!/bin/bash
if git status -s | grep -q "M CHANGELOG"; then
exit 0
else
echo "# CHANGELOG Not updated."
exit 1
fi
Please notice that commit hooks are not versioned nor included in the repository
123
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
