diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index e4e58f9..a14a16d 100644 --- 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 index bd9d550..507aa5b 100644 --- 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