feat: reusable infrastructure for creating AUTHORS files

.github/workflows/test.yml

@@ -19,6 +19,7 @@ jobs:
           key:
             ${{ runner.os }}-cococo-node-${{
             hashFiles('conventional_commit_config/package-lock.json') }}
+      - run: cd authors && make test
       - run: cd conventional_commit_config && make test
       - run: cd changelog && make test
       - run: cd licenses && make test

Makefile

@@ -1,4 +1,5 @@
 format:  # formats all code bases
+	(cd authors && make --no-print-dir format)
 	(cd changelog && make --no-print-dir format)
 	(cd conventional_commit_config && make --no-print-dir format)
 	(cd licenses && make --no-print-dir format)

authors/Makefile

@@ -0,0 +1,24 @@
+format: .bin/shfmt
+	echo formatting source code ...
+	.bin/shfmt --write .
+
+test: .bin/shellcheck .bin/shfmt  # runs all automated tests
+	echo running tests ...
+	.bin/shellcheck authors.sh
+	.bin/shfmt --diff .
+
+.bin/shellcheck: Makefile
+	echo installing Shellcheck ...
+	curl -sSL https://github.com/koalaman/shellcheck/releases/download/stable/shellcheck-stable.linux.x86_64.tar.xz | tar xJ
+	mkdir -p .bin
+	mv shellcheck-stable/shellcheck .bin
+	rm -rf shellcheck-stable
+	touch .bin/shellcheck   # update the timestamp so that Make doesn't re-install Shellcheck each time it runs
+
+.bin/shfmt: Makefile
+	echo installing Shellfmt ...
+	mkdir -p .bin
+	curl -sSL https://github.com/mvdan/sh/releases/download/v3.5.1/shfmt_v3.5.1_linux_amd64 -o .bin/shfmt
+	chmod +x .bin/shfmt
+
+.SILENT:

authors/authors.sh

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+
+# This script creates an AUTHORS file similar to https://github.com/google/go-github/blob/master/AUTHORS
+# listing the authors of the product in the current directory. Call it like this:
+#
+# 	curl https://raw.githubusercontent.com/ory/ci/master/authors/authors.sh | env PRODUCT=<product name> bash
+
+##############################
+# CONFIGURATION
+
+# name of the file to create
+filename=AUTHORS
+
+# entries to ignore
+ignores=(ory-bot dependabot circleci@ory.am kevin.goslar@originate.com)
+
+##############################
+# IMPLEMENTATION
+
+# verify arguments
+if [ -z "$PRODUCT" ]; then
+	echo "Usage: env PRODUCT=<product name>" "$0"
+	exit 1
+fi
+
+# determine all authors from the Git history
+authors=$(git log --pretty=format:"%an <%ae>" | sort | uniq)
+
+# filter entries to ignore
+for ignore in "${ignores[@]}"; do
+	authors=$(echo "$authors" | grep -v "$ignore")
+done
+
+# write file
+{
+	echo "# This is the official list of $PRODUCT authors."
+	echo "# If you don't want to be on this list, please contact Ory."
+	echo ""
+	echo "$authors"
+} >$filename
+
+# print success message
+count=$(echo "$authors" | wc -l)
+echo "Identified $count contributors."