diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index a14a16d..e4e58f9 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -5,9 +5,11 @@ on: [ push ] jobs: ci: runs-on: [ ubuntu-latest ] + env: + GOMARKDOC_OPTS: -c strategy: matrix: - target: [ test, lint, verify-docs ] + target: [ test, lint, docs ] steps: - uses: actions/checkout@v4 - uses: actions/setup-go@v4 diff --git a/Makefile b/Makefile index 507aa5b..74ff6e5 100644 --- a/Makefile +++ b/Makefile @@ -87,8 +87,3 @@ $(GOPATH)/bin/gomarkdoc: 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