Skip to content

Commit 8ec28b2

Browse files
committed
ci: verify that documentation is up-to-date
1 parent 8feab84 commit 8ec28b2

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

.github/workflows/main.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,26 @@ jobs:
8585
- name: lint
8686
run: make lint
8787

88+
########################
89+
# Verify documentation
90+
########################
91+
docs-check:
92+
name: verify that auto-generated documentation is up-to-date
93+
runs-on: ubuntu-latest
94+
steps:
95+
- name: git checkout
96+
uses: actions/checkout@v2
97+
with:
98+
fetch-depth: 0
99+
100+
- name: setup go ${{ env.GO_VERSION }}
101+
uses: actions/setup-go@v5
102+
with:
103+
go-version: '~${{ env.GO_VERSION }}'
104+
105+
- name: check
106+
run: make docs-check
107+
88108
########################
89109
# run unit tests
90110
########################

0 commit comments

Comments
 (0)