Add a CI workflow that checks commiter/author emails against the AUTHORS file.

Author: sean219design

.github/workflows/verify_authors.yml

@@ -0,0 +1,30 @@
+#
+# Copyright (c) 2022, 219 Design, LLC
+# See LICENSE.txt
+#
+# https://www.219design.com
+# Software | Electrical | Mechanical | Product Design
+#
+name: verify_authors
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v1
+
+      # Remove apt repos that are known to break from time to time
+      # See https://github.com/actions/virtual-environments/issues/323
+      - name: Remove broken apt repos
+        run: |
+          for apt_file in `grep -lr microsoft /etc/apt/sources.list.d/`; do sudo rm $apt_file; done
+
+      - if: runner.os == 'Linux'
+        # Fix (another kind) of azure ubuntu apt repo issue. (Unable to connect to azure.archive.ubuntu.com)
+        run: sed -e 's/azure.archive.ubuntu.com/us.archive.ubuntu.com/g' -e t -e d /etc/apt/sources.list | sudo tee /etc/apt/sources.list.d/nonazure.list
+
+      - name: verify_authors
+        run: ./verify_authors.sh

AUTHORS

@@ -0,0 +1,5 @@
+# New contributors must add their name and email for this git repository
+# following the format reported by `git shortlog -sen | cut -f 2`.
+
+Sean Moore <sean@219design.com>
+

verify_authors.sh

@@ -0,0 +1,100 @@
+#!/bin/bash
+
+#
+# Copyright (c) 2022, 219 Design, LLC
+# See LICENSE.txt
+#
+# https://www.219design.com
+# Software | Electrical | Mechanical | Product Design
+#
+
+set -euo pipefail # https://vaneyckt.io/posts/safer_bash_scripts_with_set_euxo_pipefail/
+IFS=$'\n\t'
+
+function error() {
+    echo $@ >& /dev/stderr
+}
+
+function missing_primary_branch() {
+    error "Did you use the wrong branch?"
+    git branch -a
+}
+
+PRIMARY_BRANCH=origin/master
+echo "Primary branch is ${PRIMARY_BRANCH}."
+
+trap missing_primary_branch EXIT
+ancestor_commit=$(git merge-base ${PRIMARY_BRANCH} HEAD)
+trap "" EXIT
+echo "The most recent common ancestor commit with the primary branch is ${ancestor_commit}."
+
+authors=$(cat AUTHORS)
+git_authors=$(git shortlog -se ${ancestor_commit}..HEAD | cut -f 2)
+git_committers=$(git shortlog -se --committer ${ancestor_commit}..HEAD | cut -f 2)
+
+echo
+echo "AUTHORS file lines:"
+for author in $authors
+do
+    echo $author
+done
+
+echo
+echo "git Authors:"
+for git_author in $git_authors
+do
+    echo $git_author
+done
+
+echo
+echo "git Committers:"
+for git_committer in $git_committers
+do
+    echo $git_committer
+done
+
+echo
+
+echo "Checking git Authors."
+for git_author in $git_authors
+do
+    found=0
+    for author in $authors
+    do
+        if [ "$git_author" == "$author" ]
+        then
+            found=1
+        fi
+    done
+
+    if [ 0 -eq $found ]
+    then
+        error "Failed to find git author \"${git_author}\" in AUTHORS file."
+        error "Note that \`git commit --amend\` is not sufficient to change a commit author."
+        exit -1
+    fi
+done
+echo "Verified git Authors."
+
+echo "Checking git Committers."
+for git_committer in $git_committers
+do
+    found=0
+    for author in $authors
+    do
+        if [ "$git_committer" == "$author" ]
+        then
+            found=1
+        fi
+    done
+
+    if [ 0 -eq $found ]
+    then
+        error "Failed to find git committer \"${git_committer}\" in AUTHORS file."
+        error "Note that you can't see the committer with \`git log\` but can with \`git log --pretty=full\`."
+        exit -1
+    fi
+done
+echo "Verified git Committers."
+
+echo "Contributions verified."