Skip to content

Commit

Permalink
Revert to -c since hand rolled verify-docs didn't work either.
Browse files Browse the repository at this point in the history
  • Loading branch information
kennyp committed Oct 22, 2024
1 parent b4a8a9e commit 1b9ec87
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 6 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 0 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 1b9ec87

Please sign in to comment.