ci: make sure golden files are actually up to date

coder · mafredri · Jan 2, 2025 · Dec 31, 2024 · Dec 31, 2024 · Dec 31, 2024
commit ad3073687072d30721fd6b95a5ca8eb3548d6a34
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -271,6 +271,12 @@ jobs:
         # coderd/rbac/object_gen.go:1:1: syntax error: package statement must be first
         run: "make --output-sync -B gen"
 
+      - name: make update-golden-files
+        # As above, skip `-j` flag.
+        run: |
+          make clean/golden-files
+          make --output-sync -B update-golden-files
+
       - name: Check for unstaged files
         run: ./scripts/check_unstaged.sh
 

diff --git a/Makefile b/Makefile
@@ -702,18 +702,33 @@ coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen $(FIND_EXCLUSIONS)
 
 update-golden-files: \
 	cli/testdata/.gen-golden \
-	helm/coder/tests/testdata/.gen-golden \
-	helm/provisioner/tests/testdata/.gen-golden \
-	enterprise/cli/testdata/.gen-golden \
-	enterprise/tailnet/testdata/.gen-golden \
-	tailnet/testdata/.gen-golden \
 	coderd/.gen-golden \
 	coderd/notifications/.gen-golden \
-	provisioner/terraform/testdata/.gen-golden
+	enterprise/cli/testdata/.gen-golden \
+	enterprise/tailnet/testdata/.gen-golden \
+	helm/coder/tests/testdata/.gen-golden \
+	helm/provisioner/tests/testdata/.gen-golden \
+	provisioner/terraform/testdata/.gen-golden \
+	tailnet/testdata/.gen-golden
 .PHONY: update-golden-files
 
+clean/golden-files:
+	find . -type f -name '.gen-golden' -delete
+	find \
+		cli/testdata \
+		coderd/notifications/testdata \
+		coderd/testdata \
+		enterprise/cli/testdata \
+		enterprise/tailnet/testdata \
+		helm/coder/tests/testdata \
+		helm/provisioner/tests/testdata \
+		provisioner/terraform/testdata \
+		tailnet/testdata \
+		-type f -name '*.golden' -delete
+.PHONY: clean/golden-files
+
 cli/testdata/.gen-golden: $(wildcard cli/testdata/*.golden) $(wildcard cli/*.tpl) $(GO_SRC_FILES) $(wildcard cli/*_test.go)
-	go test ./cli -run="Test(CommandHelp|ServerYAML|ErrorExamples)" -update
+	go test ./cli -run="Test(CommandHelp|ServerYAML|ErrorExamples|.*Golden)" -update
 	touch "$@"
 
 enterprise/cli/testdata/.gen-golden: $(wildcard enterprise/cli/testdata/*.golden) $(wildcard cli/*.tpl) $(GO_SRC_FILES) $(wildcard enterprise/cli/*_test.go)

diff --git a/cli/testdata/coder_templates_plan_--help.golden b/cli/testdata/coder_templates_plan_--help.golden
diff --git a/enterprise/cli/testdata/coder_provisionerd_--help.golden b/enterprise/cli/testdata/coder_provisionerd_--help.golden
diff --git a/enterprise/cli/testdata/coder_provisionerd_keys_--help.golden b/enterprise/cli/testdata/coder_provisionerd_keys_--help.golden
diff --git a/enterprise/cli/testdata/coder_provisionerd_keys_create_--help.golden b/enterprise/cli/testdata/coder_provisionerd_keys_create_--help.golden
diff --git a/enterprise/cli/testdata/coder_provisionerd_keys_delete_--help.golden b/enterprise/cli/testdata/coder_provisionerd_keys_delete_--help.golden
diff --git a/enterprise/cli/testdata/coder_provisionerd_keys_list_--help.golden b/enterprise/cli/testdata/coder_provisionerd_keys_list_--help.golden
diff --git a/enterprise/cli/testdata/coder_provisionerd_start_--help.golden b/enterprise/cli/testdata/coder_provisionerd_start_--help.golden
diff --git a/enterprise/cli/testdata/coder_wsproxy_--help.golden b/enterprise/cli/testdata/coder_wsproxy_--help.golden