Add verify-docs target.

heroku · Oct 22, 2024 · b4a8a9e · b4a8a9e
1 parent 338d843
commit b4a8a9e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -5,11 +5,9 @@ on: [ push ]
 jobs:
   ci:
     runs-on: [ ubuntu-latest ]
-    env:
-      GOMARKDOC_OPTS: -c
     strategy:
       matrix:
-        target: [ test, lint, docs ]
+        target: [ test, lint, verify-docs ]
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-go@v4

diff --git a/Makefile b/Makefile
@@ -86,3 +86,9 @@ $(GOPATH)/bin/gomarkdoc:
 .PHONY: docs
 docs: $(GOPATH)/bin/gomarkdoc ## Generate docs using gomarkdoc
 	$< $(GOMARKDOC_OPTS) -o ./dynoid/README.md -e ./dynoid/...
+
+.PHONY: verify-docs
+verify-docs: $(GOPATH)/bin/gomarkdoc
+	@cp ./dynoid/README.md ./dynoid/README.md.orig
+	@$< $(GOMARKDOC_OPTS) -o ./dynoid/README.md -e ./dynoid/...
+	@if ! cmp ./dynoid/README.md ./dynoid/README.md.orig; then printf "docs not generated\n" >&2; false; fi