✅ Contains simple examples of prepare-commit-msg, commit-msg** hooks.
- Prepare-commit-msg hook adds a prefix to commit message with Jira ticket from a branch name in brackets
(ex.
ABC-123-bugfix -> [ABC-123] initial commit msg).
To be triggered by hook branch name contains a substring that complies with pattern: ^[A-Z]{1,9}-[0-9]{1,9}
The diagram below shows the workflow of the prepare-commit-msg hook.
- Commit-msg hook is intended to help developers to formalize commit messages. It checks typed commit message for the presence of the specified template and declines commit if message doesn't correspond to the template.
- Python 3.* installed
- Windows 10 or Mac OS 11, Linux (ex. Ubuntu)
- Git 2.3
- Download file with hook - python script
- For Python hook you're also going to need Python 3 installed (Mac has it out of the box, but on Windows you have to set it up manually).
- Make sure filename is prepare-commit-msg or commit-msg
- Make chosen file executable using chmod +x prepare-commit-msg (on Windows works via Git Bash just fine) or chmod 755 prepare-commit-msg
- Put the file into every project you want to use githook for. Destination folder looks like: your_project/.git/hooks
- Alternatively, you can specify general folder for git to look for hooks instead of putting them into every project .git/hooks folder.
Use command below with path to your global hooks directory
git config --global core.hooksPath /usr/local/.../git/hooks
Now if you execute
git config --global --list
You're breathtaking!
- Download pairs of hooks from windows directory
- Copy them into your_project/.git/hooks directory or add to git global config
- Do not forget to make files executable
- Make sure Python is added to Path on your machine
- Note that hook on Windows consists of two scripts: shell script calling python script
Git hooks are triggered automatically if they are located in .git directory in your repository or in global folder (see above for instruction).
In case any problems occur check every step of the installation process.
Also see article on the subject published on Habr --> https://habr.com/ru/company/dins/blog/584562/
Roman Gorbatenko
@Elanlum