dist/tools: add more forbidden keywords to PR check

Author: crasbe

dist/tools/pr_check/check.sh

@@ -17,6 +17,13 @@ cd "$RIOTBASE" || exit
 
 EXIT_CODE=0
 
+# Keywords that should trigger the commit message check and prevent an accidental
+# merge of something not meant to be merged.
+# The pretty-print format of the commit messages is always the following:
+# `a5e4f038b8 commit message`
+# This has to be reflected in the RegEx matching pattern.
+NOMERGE_KEYWORD_FILE="$(dirname "$0")/no_merge_keywords"
+
 github_annotate_setup
 
 if tput colors &> /dev/null && [ "$(tput colors)" -ge 8 ]; then
@@ -33,30 +40,28 @@ else
     RIOT_MASTER="master"
 fi
 
-keyword_filter() {
-    grep -i \
-        -e "^    [0-9a-f]\+ .\{0,2\}SQUASH" \
-        -e "^    [0-9a-f]\+ .\{0,2\}FIX" \
-        -e "^    [0-9a-f]\+ .\{0,2\}REMOVE *ME" \
-        -e "^    [0-9a-f]\+ .\{0,2\}Update"
-}
-
-SQUASH_COMMITS="$(git log "$(git merge-base HEAD "${RIOT_MASTER}")"...HEAD --pretty=format:"    %h %s" | \
-                  keyword_filter)"
+SQUASH_COMMITS="$(git log "$(git merge-base HEAD "${RIOT_MASTER}")"...HEAD --pretty=format:"%h %s" | \
+                grep -i -f "${NOMERGE_KEYWORD_FILE}")"
 
 if [ -n "${SQUASH_COMMITS}" ]; then
     if github_annotate_is_on; then
-        echo "${SQUASH_COMMITS}" | while read -r commit; do
-            ANNOTATION="Commit needs to be squashed: \"${commit}\""
-            ANNOTATION="${ANNOTATION}\n\nPLEASE ONLY SQUASH WHEN ASKED BY A "
+        ANNOTATION=""
+        while read -r commit; do
+            ANNOTATION="${ANNOTATION}Commit needs to be squashed or contains a no-merge keyword: \"${commit}\"\n"
+        done < <(echo "${SQUASH_COMMITS}")
+
+        if [ -n "${ANNOTATION}" ]; then
+            ANNOTATION="${ANNOTATION}\nPLEASE ONLY SQUASH WHEN ASKED BY A "
             ANNOTATION="${ANNOTATION}MAINTAINER!"
             ANNOTATION="${ANNOTATION}\nSee: "
-            ANNOTATION="${ANNOTATION}https://github.com/RIOT-OS/RIOT/blob/master/CONTRIBUTING.md#squash-commits-after-review"
+            ANNOTATION="${ANNOTATION}https://github.com/RIOT-OS/RIOT/blob/master/CONTRIBUTING.md#squash-commits-after-review\n"
             github_annotate_error_no_file "${ANNOTATION}"
-        done
+        fi
     else
-        echo -e "${CERROR}Pull request needs squashing:${CRESET}" 1>&2
-        echo -e "${SQUASH_COMMITS}"
+        echo -e "${CERROR}Pull request needs squashing or contains no-merge keywords:${CRESET}" 1>&2
+        while IFS= read -r line; do
+            echo -e "    ${line}"
+        done <<< "${SQUASH_COMMITS}"
     fi
     EXIT_CODE=1
 fi

dist/tools/pr_check/no_merge_keywords

@@ -0,0 +1,12 @@
+[0-9a-f]\+ SQUASH
+[0-9a-f]\+ FIX
+[0-9a-f]\+ REMOVE *ME
+[0-9a-f]\+ Update
+[0-9a-f]\+ \<DONOTMERGE\>
+[0-9a-f]\+ \<DO NOT MERGE\>
+[0-9a-f]\+ \<DON'T MERGE\>
+[0-9a-f]\+ \<NO MERGE\>
+[0-9a-f]\+ \<DELETE ME\>
+[0-9a-f]\+ \<DELETEME\>
+[0-9a-f]\+ \<WIP\>
+[0-9a-f]\+ \<TEMP\>