Merge pull request #123 from thefirstofthe300/ds/add-check-generate-docs

Add check for generating docs

Author: aaron-lane

Makefile

@@ -24,7 +24,11 @@ DOCKER_TAG_KITCHEN_TERRAFORM ?= ${DOCKER_TAG_BASE_KITCHEN_TERRAFORM}
 DOCKER_IMAGE_KITCHEN_TERRAFORM := cft/kitchen-terraform_terraform-google-kubernetes-engine
 
 # All is the first target in the file so it will get picked up when you just run 'make' on its own
-all: check_shell check_python check_golang check_terraform check_docker check_base_files test_check_headers check_headers check_trailing_whitespace generate_docs
+.PHONY: all
+all: check generate_docs
+
+.PHONY: check
+check: check_shell check_python check_golang check_terraform check_docker check_base_files test_check_headers check_headers check_trailing_whitespace check_generate_docs
 
 # The .PHONY directive tells make that this isn't a real target and so
 # the presence of a file named 'check_shell' won't cause this target to stop
@@ -71,6 +75,10 @@ check_headers:
 	@echo "Checking file headers"
 	@python test/verify_boilerplate.py
 
+.PHONY: check_generate_docs
+check_generate_docs: ## Check that `make generate_docs` does not generate a diff
+	@source test/make.sh && check_generate_docs
+
 # Integration tests
 .PHONY: test_integration
 test_integration:

test/make.sh

@@ -96,3 +96,22 @@ function generate_docs() {
   done
   rm -f "$TMPFILE"
 }
+
+function check_generate_docs() {
+  TMPDIR=$(mktemp -d)
+  git worktree add --detach "$TMPDIR" >/dev/null
+  cd "$TMPDIR" || exit 1
+
+  make generate_docs >/dev/null
+  git diff --stat --exit-code >/dev/null
+  rc=$?
+  cd - >/dev/null || exit 1
+
+  if [[ $rc -ne 0 ]]; then
+    echo '"make generate_docs" creates a diff, run "make generate_docs" and commit the results'
+  fi
+  rm -rf "$TMPDIR"
+  git worktree prune >/dev/null
+
+  exit $rc
+}