Skip to content

Commit 8f2e483

Browse files
committed
ci: deny rustdoc warnings when building docs
The failures this catches are silent ones. A doc link to a crate-private item is a warning, not an error, and rustdoc renders it as plain text — so the published page quietly loses the link and the build stays green. Three such links reached main before being noticed by hand.
1 parent 35e5e9c commit 8f2e483

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

.github/workflows/test.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,13 @@ jobs:
7979
- name: Clippy (engine comparison)
8080
run: cargo clippy -p pagedb-engine-comparison --all-targets -- -D warnings
8181

82+
# Warnings are denied because the failures that matter here are silent:
83+
# a link to a crate-private item renders as plain text rather than
84+
# erroring, so the published docs lose it and nothing reports why.
8285
- name: Build docs
8386
run: cargo doc -p pagedb --no-deps --all-features
87+
env:
88+
RUSTDOCFLAGS: -D warnings
8489

8590
- name: Run doctests
8691
run: cargo test -p pagedb --doc --all-features

0 commit comments

Comments
 (0)