From 09cf4a17e093ea55122ac4d8c051c83e36d9141a Mon Sep 17 00:00:00 2001
From: Paul Donald <newtwen@gmail.com>
Date: Tue, 30 Jan 2024 14:56:06 +0100
Subject: [PATCH] house-keeping: PR workflow check improvements

---
 .github/workflows/formal.yml | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/formal.yml b/.github/workflows/formal.yml
index 548e1b279281..607585b92319 100644
--- a/.github/workflows/formal.yml
+++ b/.github/workflows/formal.yml
@@ -22,7 +22,7 @@ jobs:
           echo "Building for $BRANCH"
           echo "BRANCH=$BRANCH" >> $GITHUB_ENV
 
-      - name: Test for merge, subject and S.O.B.
+      - name: Test for merge commits, subject, S.O.B., and email
         run: |
           source .github/workflows/ci_helpers.sh
 
@@ -34,22 +34,54 @@ jobs:
               RET=1
             fi
 
+            authorname="$(git show -s --format=%aN $commit)"
+            if echo $authorname | grep -q '\S\+\s\+\S\+'; then
+              success "Author name ($authorname) seems ok"
+            elif echo $authorname | grep -q '\S\+'; then
+              success "Author name ($authorname) seems to be nick or alias"
+            else
+              err "Author name ($authorname) must be one of: real name 'firstname lastname' OR nickname/alias/handle "
+              RET=1
+            fi
+
+            committername="$(git show -s --format=%cN $commit)"
+            # Pattern \S\+\s\+\S\+ matches >= 2 names i.e. 3 and more e.g. "John Von Doe" also match
+            if echo $committername | grep -q '\S\+\s\+\S\+'; then
+              success "Committer name ($committername) seems ok"
+            elif echo $committername | grep -q '\S\+'; then
+              # Pattern \S\+ matches single names, typical of nicks or handles
+              success "Committer name ($committername) seems to be nick or alias"
+            else
+              err "Committer name ($committername) must be one of: real name 'firstname lastname' OR nickname/alias/handle "
+              RET=1
+            fi
+
             subject="$(git show -s --format=%s $commit)"
             if echo "$subject" | grep -q -e '^[0-9A-Za-z,+/_-]\+: ' -e '^Revert '; then
               success "Commit subject line seems ok ($subject)"
+            elif echo "$subject" | grep -iq '^Translated using Weblate.*'; then
+              success "Weblate commit subject line exception OK: $subject"
             else
               err "Commit subject line MUST start with '<package name>: ' ($subject)"
               RET=1
             fi
 
             body="$(git show -s --format=%b $commit)"
+            authoremail="$(git show -s --format='<%aE>' $commit)"
             sob="$(git show -s --format='Signed-off-by: %aN <%aE>' $commit)"
             if echo "$body" | grep -qF "$sob"; then
               success "Signed-off-by matches author"
+            elif echo "$authoremail" | grep -iqF "<hosted@weblate.org>"; then
+              success "Signed-off-by exception: authored by Weblate"
             else
               err "Signed-off-by is missing or doesn't match author (should be '$sob')"
               RET=1
             fi
+
+            if echo "$authoremail" | grep -iqF "users.noreply"; then
+              err "Real email address policy: please configure GitHub email ($authoremail) to a real one"
+              RET=1
+            fi
           done
 
           exit $RET