summaryrefslogtreecommitdiffstats
path: root/extras/scripts/check_commit_msg.sh
diff options
context:
space:
mode:
Diffstat (limited to 'extras/scripts/check_commit_msg.sh')
-rwxr-xr-xextras/scripts/check_commit_msg.sh50
1 files changed, 50 insertions, 0 deletions
diff --git a/extras/scripts/check_commit_msg.sh b/extras/scripts/check_commit_msg.sh
new file mode 100755
index 00000000000..ec9db60c15e
--- /dev/null
+++ b/extras/scripts/check_commit_msg.sh
@@ -0,0 +1,50 @@
+#/bin/env bash
+
+KNOWN_FEATURES=$(cat MAINTAINERS | sed -ne 's/^I:[[:space:]]*//p')
+FEATURES=$(git show -s --format=%s --no-color | sed -e 's/\(.*\):.*/\1/')
+KNOWN_TYPES="fix refactor style docs test make"
+TYPE=$(git show -s --format=%b --no-color | sed -ne 's/^Type:[[:space:]]*//p')
+ERR="=============================== ERROR ==============================="
+
+# Chech that subject line contains at least one feature id
+if [ $(echo ${FEATURES} | wc -w) -eq 0 ]; then
+ echo $ERR
+ echo "git commit 'Subject:' line must contain at least one known feature id."
+ echo "feature id(s) must be listed before ':' and space delimited "
+ echo "if more then one is listed."
+ echo "Please reffer to MAINTAINERS file (I: lines) for known feature ids."
+ echo $ERR
+ exit 1
+fi
+
+# Check that feature ids in subject line are known
+for i in ${FEATURES}; do
+ is_known=false
+ for j in ${KNOWN_FEATURES}; do
+ [ "${i}" = "${j}" ] && is_known=true
+ done
+ if [ ${is_known} = "false" ] ; then
+ echo $ERR
+ echo "Unknown feature '${i}' in commit 'Subject:' line."
+ echo "Feature must exist in MAINTAINERS file. If this commit intruduces "
+ echo "new feature, then this commit must add new entry into the "
+ echo "MAINTAINERS file."
+ echo $ERR
+ exit 1
+ fi
+done
+
+# Check that Message body contains valid Type: entry
+is_known=false
+for i in ${KNOWN_TYPES}; do
+ [ "${i}" = "${TYPE}" ] && is_known=true
+done
+if [ ${is_known} = "false" ] ; then
+ echo $ERR
+ echo "Unknown commit type '${TYPE}' in commit message body."
+ echo "Commit message must contain known 'Type:' entry."
+ echo "Known types are: ${KNOWN_TYPES}"
+ echo $ERR
+ exit 1
+fi
+