feat: Add checker to ensure that env variable doc is up to date (#5091)

Signed-off-by: Simon Behar <simbeh7@gmail.com>

Makefile

@@ -259,6 +259,7 @@ codegen: \
 	go generate ./persist/sqldb ./pkg/apiclient/workflow ./server/auth ./server/auth/sso ./workflow/executor
 	rm -Rf vendor
 	go mod tidy
+	./hack/check-env-doc.sh
 
 $(GOPATH)/bin/mockery:
 	./hack/recurl.sh dist/mockery.tar.gz https://github.com/vektra/mockery/releases/download/v1.1.1/mockery_1.1.1_$(shell uname -s)_$(shell uname -m).tar.gz

docs/environment-variables.md

@@ -23,6 +23,8 @@ Note that these environment variables may be removed at any time.
 | `TRANSIENT_ERROR_PATTERN` | `string` | The regular expression that represents additional patterns for transient errors. |
 | `WF_DEL_PROPAGATION_POLICY` | `string` | The deletion propogation policy for workflows. |
 | `WORKFLOW_GC_PERIOD` | `time.Duration` | The periodicity for GC of workflows. |
+| `BUBBLE_ENTRY_TEMPLATE_ERR` | `bool` | Whether to bubble up template errors to workflow. Default true |
+| `INFORMER_WRITE_BACK` | `bool` | Whether to write back to informer instead of catching up. Deafult true |
 
 ## Executor
 

hack/check-env-doc.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+echo "Checking docs/environment-variables.md for completeness..."
+
+function check-used {
+    grep "| \`" < ./docs/environment-variables.md \
+      | awk '{gsub(/\`/, "", $2);  print $2; }' \
+      | while read -r x; do
+        var="${x%\`}";
+        var="${var#\`}";
+        if ! grep -qR --exclude="*_test.go" "$var" ./workflow ./persist ./util; then
+          echo "Documented variable $var in docs/environment-variables.md is not used anywhere";
+          exit 1;
+        fi;
+      done
+}
+
+function check-documented {
+    grep -REh --exclude="*_test.go" "Getenv.*?\(|LookupEnv.*?\(" ./workflow ./persist ./util \
+      | grep -Eo "\"[A-Z_]+?\"" \
+      | sort \
+      | uniq \
+      | while read -r x; do
+        var="${x%\"}";
+        var="${var#\"}";
+        if ! grep -q "$var" docs/environment-variables.md; then
+          echo "Variable $var not documented in docs/environment-variables.md";
+          exit 1;
+        fi;
+      done
+}
+
+check-used && check-documented && echo "Success!"