diff options
author | Amir Ghorbanian <deanghorbanian@gatech.edu> | 2020-07-03 17:13:45 -0400 |
---|---|---|
committer | Amir Ghorbanian <deanghorbanian@gatech.edu> | 2020-07-15 10:01:49 -0400 |
commit | 284a969cc082ae3c63ab523f22e71da86ad4ab20 (patch) | |
tree | ae41f67675022a93887a671f2500fa7e384a7ce9 | |
parent | 3276c148c4cac7b7c9adbaab5997b26488612085 (diff) | |
download | bitcoin-284a969cc082ae3c63ab523f22e71da86ad4ab20.tar.xz |
Linter to check commit message formatting
Write linter to check that commit messages have a new line before the body or no body at all.
reference: gist.github.com/agnivade/67b42d664ece2d4210c7
Fixes issue #19091.
-rwxr-xr-x | test/lint/lint-git-commit-check.sh | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/test/lint/lint-git-commit-check.sh b/test/lint/lint-git-commit-check.sh new file mode 100755 index 0000000000..7cffd267dd --- /dev/null +++ b/test/lint/lint-git-commit-check.sh @@ -0,0 +1,46 @@ +#!/usr/bin/env bash +# Copyright (c) 2020 The Bitcoin Core developers +# Distributed under the MIT software license, see the accompanying +# file COPYING or http://www.opensource.org/licenses/mit-license.php. +# +# Linter to check that commit messages have a new line before the body +# or no body at all + +export LC_ALL=C + +EXIT_CODE=0 + +while getopts "?" opt; do + case $opt in + ?) + echo "Usage: $0 [N]" + echo " TRAVIS_COMMIT_RANGE='<commit range>' $0" + echo " $0 -?" + echo "Checks unmerged commits, the previous N commits, or a commit range." + echo "TRAVIS_COMMIT_RANGE='47ba2c3...ee50c9e' $0" + exit ${EXIT_CODE} + ;; + esac +done + +if [ -z "${TRAVIS_COMMIT_RANGE}" ]; then + if [ -n "$1" ]; then + TRAVIS_COMMIT_RANGE="HEAD~$1...HEAD" + else + TRAVIS_COMMIT_RANGE="origin/master..HEAD" + fi +fi + +while IFS= read -r commit_hash || [[ -n "$commit_hash" ]]; do + n_line=0 + while IFS= read -r line || [[ -n "$line" ]]; do + n_line=$((n_line+1)) + length=${#line} + if [ $n_line -eq 2 ] && [ $length -ne 0 ]; then + echo "The subject line of commit hash ${commit_hash} is followed by a non-empty line. Subject lines should always be followed by a blank line." + EXIT_CODE=1 + fi + done < <(git log --format=%B -n 1 "$commit_hash") +done < <(git log "${TRAVIS_COMMIT_RANGE}" --format=%H) + +exit ${EXIT_CODE} |