Skip to content

Commit 084eaac

Browse files
committed
Let CI catch api docs that no longer match the source
The generated reference drifted unnoticed in two packages, so CI now regenerates it and fails when the result differs from what is committed.
1 parent dc6c929 commit 084eaac

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,8 @@ jobs:
3333

3434
- name: Run the tests
3535
run: make test
36+
37+
- name: Check that the api docs match the source
38+
run: |
39+
make docs
40+
git diff --exit-code docs || { echo "The api docs are out of date, run 'make docs'"; exit 1; }

0 commit comments

Comments
 (0)