A simple git commit checker. I often use a commit message template I created a while ago, and I wanted to make sure that everything was in the right place after writing a commit, that's why this script exists. Use it if you want to git gud too. To add this custom git command to git, just place the file in a folder that's in your path (a.k.a PATH). You can setup git-gud as custom command or setup git-gud as post-commit hook.
You can use the same commit limmits as in git log: --author, --number, --until, --before, and more. (git-log docs). Some basic examples:
# Check last commit
$ git gud
# Check <number> commits in the current branch
$ git gud -<number>
$ git gud -n <number>
$ git gud --max-count=<number>
# Check commits in another branch
$ git gud <branch>
$ git gud <branch> -<number>
$ git gud -n <number> <branch>
# And... a sample output
$ git gud
Checking... afaeaf5
> OK: Author name format is valid (Antonio Ossa)
> OK: Author email format is valid ([email protected])
> OK: Commiter name format is valid (Antonio Ossa)
> OK: Commiter email format is valid ([email protected])
> ERROR: Subject is too long (59 > 50)
> ERROR: Body is empty (0 == 0)
> OK: Body includes comment (2 > 0)
> OK: 'Signed-off-by' line is not empty (42 > 0)
> OK: 'Signed-off-by' line has author information
> WARNING: Signature is not valid (Status: N)- Commit author name is in a valid format (
Antonio Ossa) - Commit author name is the same in your config file
- Commit author email is in a valid format (
[email protected]) - Commit author email is the same in your config file
- Commit subject message uses a maximum of 50 characters
- Commit body message is not empty
- Commit body message lines use a maximum of 72 characters
- Commit body message has lines with comments (i.e. not "Signed-off-by: ...")
- Commit body message has a "Signed-off-by: ..." line (
Signed-off-by: Antonio Ossa <[email protected]>) - Commit signature is "good"
This is the template I use. You can find it as .gitmessage in this repo and install it following these instructions. The script assumes that you're following these conventions, but you can use your own template if you want (or none) and customize the checker too! That's why is OSS ❤️:
# |<---- Using a Maximum Of 50 Characters ---->|
# If this commit is applied, it will...
# Examples of imperative mood: Refactor X, Update Y, Remove Z
Subject
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# What/why/how was this change made?
# Any references to relevant tickets, articles, resources, etc?
# Example: GitHub issue #23
# Something more?
# Reported-by: A person or @somebody
Signed-off-by: Antonio Ossa <[email protected]>
# (:heart: emoji? http://emoji.muan.co/)
-
Wiki: How to use template -
Instructions: Use git-gud as custom command -
Instructions: Use git-gud as post-commit hook -
Script: Allow check multiple commits (git gud -n 10) -
Script: Allow check on another branch (git gud branch) - Script: Check imperative mood in subject
- Script: Add flags about output verbosity (
--full/current,--warn/warnings+errors,--error/errors only)
This software is released under the MIT License
