test out commit checker

Author: fullstackzach

.github/workflows/CommitChecker.yml

@@ -0,0 +1,62 @@
+name: Commit Checker
+
+# Run on push to any branch
+on: [pull_request]
+
+jobs:
+  Commit_Checker:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+        ref: '${{ github.event.pull_request.base.ref }}'
+
+    - name: Commit validation
+      run: |
+        # Checkout branch
+        git checkout -q ${{ github.event.pull_request.head.ref }}
+        
+        # Set variables
+        BASE_BRANCH=${{ github.event.pull_request.base.ref }}
+        msg_regex='(AAA|BBB|CCC)\-[0-9]+'
+        
+        # Initialize invalidCommit as false, will be set to true by any invalid commits
+        invalidCommit=false
+        # Find current branch name
+        CURRENT_BRANCH=$(git branch | grep ^\* | cut -d "*" -f 2 | cut -d " " -f 2)
+        #echo "Current branch is:" $CURRENT_BRANCH
+        # Find hash of commit most common ancestor, e.g. where branch began
+        BRANCH_MERGE_BASE=$(git merge-base ${BASE_BRANCH} ${CURRENT_BRANCH})
+        #echo "Branch merge base hash is:" $BRANCH_MERGE_BASE
+        # Find all commits since common ancestor
+        BRANCH_COMMITS=$(git rev-list ${BRANCH_MERGE_BASE}..HEAD)
+        #echo $BRANCH_COMMITS
+        # Check every commit message since ancestor for regex match
+        for commit in $BRANCH_COMMITS; do
+            if git log --max-count=1 --format=%B $commit | tr '[a-z]' '[A-Z]' | grep -iqE "$msg_regex"; then
+                : #If commit matches regex, commit is valid, do nothing
+            else
+                # If commit doesn't match regex, commit isn't valid, print commit info
+                echo "************"
+                printf "Invalid commit message: \"%s\" and hash: %s\n" "$(git log --max-count=1 --format=%B $commit)" "$commit"
+                echo "************"
+                
+                # Set this variable to trigger rejection if any commit fails regex
+                invalidCommit=true
+            fi
+        done
+        # If any commit are invalid, print reject message
+        if [ "$invalidCommit" == true ]; then
+            echo "Your push was rejected because at least one commit message on this branch is invalid"
+            echo "Please fix the commit message(s) and push again."
+            echo "https://help.github.com/en/articles/changing-a-commit-message"
+            echo "************"
+            exit 1
+        elif [ "$invalidCommit" == false ]; then
+            echo "************"
+            echo "All commits are valid"
+            echo "************"
+            exit 0
+        fi