Prefix Issue Number - Git Hook
This is a git hook for lazy people.
Description 📚
This git hook automatically prepends a parsed issue number (from the current branch) to your commit messages on every commit. (See Usage for examples and details)
This git hook requires ruby to be installed (already pre-installed by default on macOS).
Install 🚀
Install Script
To install simply run the following command. This requires curl to be installed.
sh <(curl -s https://raw.githubusercontent.com/janniks/prepare-commit-msg/master/scripts/install.sh)If you choose the option to install globally, you will have to reinitialize all your git repositories. The following helpful command reinitializes all repositories found in sub-directories of the current directory.
find . -name .git -type d -prune -exec sh -c 'git --git-dir "{}" init' \;
Install Manually
If you prefer to install manually you can walk through the following steps:
- Copy the
scripts/prepare-commit-msgscript into your local git repository inside.git/hooks - Edit the placeholders at the beginning of the script
- Make sure the is script executable by running
chmod +x prepare-commit-msg - Enjoy! Test it by committing anything!
Usage 🔧
Simply commit as you always would! This git hook also works with tools like Tower that use native git bindings.
This git hooks will look at the current branch (e.g. type/ABC-123-branch-name) and parse the issue number and project key (e.g. ABC 123) to use for prefixing commit messages. This can be useful in connection with tools like Jira.
- If no issue number is found in the branch name, the commit message will not be modified.
- If the commit message already contains an issue number, the commit message will not be modified.
Examples
| Branch name | Entered commit message | Updated commit message |
|---|---|---|
bugfix/ABC-012-add-initial-repo |
Set up repo |
[ABC-012] Set up repo |
improvement/ABC-123-great-things |
Add files |
[ABC-123] Add files |
feature/ABC-123-something-normal |
[XYZ-321] Something different |
not modified |
Default Regular Expressions
These are the default regular expressions that are used by the script on install. They can easily be changed during install using the provided script or manually tweaked.
Parsing issue numbers from current branch name
| Detects issue number | Does not detect issue number |
|---|---|
feature/ABC-123-test-message |
abc-123-do-it |
Improvement/XYZ-ABC-321-Crazy-Name |
simple-branch-name |
Checking commit messages for existing issue numbers
| Detects issue number | Does not detect issue number |
|---|---|
[ABC-123] Test message |
Test message |
[XYZ-312] Message test |
[ABC] Testing stuff |
[XYZ-ABCD-321] Awesome sauce |
[Add ABC-123 files] |
Detecting automated commits by git
/(Merge\sbranch\s\'|\#\sRebase\s|This\sreverts\scommit\s)/
| Ignores following commits |
|---|
Merge branch 'testing' into master |
# Rebase commit 9f3bc7b |
This reverts commit 28da9f6 |
You can use tools like Regex101 to tweak and test these regular expressions.
FAQ & Problems
I already have a global git-template!
Install manually and add the git hook file to your hooks directory in your existing git-template.Uninstall 😖
If you're unhappy with this git hook:
- Simply run
rm -rf .git/hooks/prepare-commit-msgto uninstall locally - Or run
rm -rf ~/.git-template/hooks/prepare-commit-msgto uninstall globally
Please let me know what you didn't like!