Skip to content

Add docs up to date check #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tomkennedy513 merged 1 commit into from
Jul 7, 2023
Merged

Add docs up to date check #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ jobs:
with:
go-version-file: 'go.mod'

- name: Check docs up to date
run: |
set -euo pipefail
go run cmd/docs/main.go
if [[ `git status --porcelain` ]]; then
echo "Docs are not up-to-date"
exit 1
fi

- name: Run tests
run: go test -v ./pkg/...

Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/unit-test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,14 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v4

- name: Check docs up to date
run: |
set -euo pipefail
go run cmd/docs/main.go
if [[ `git status --porcelain` ]]; then
echo "Docs are not up-to-date"
exit 1
fi

- name: Test
run: go test -v ./pkg/...