ci: add doc test warning check to CI pipeline#2
Open
twenty-tools wants to merge 1 commit intomasterfrom
Open
Conversation
Adds a new CI job that runs cargo test --doc with RUSTDOCFLAGS=-D warnings, catching deprecated API usage, unused variables, and other warnings in doc comment code examples. Addresses libp2p#3282.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new CI job that runs doc tests with warnings denied, catching deprecated API usage, unused variables, and other warnings in doc comment code examples.
The existing check-rustdoc-links job catches broken intra-doc links and rustdoc-level warnings, but does not compile doc examples. This new job fills that gap by running cargo test --doc with RUSTDOCFLAGS=-D warnings.
Addresses libp2p#3282.
Summary by cubic
Adds a CI job that runs doc tests with warnings denied to catch deprecated APIs and other warnings in doc examples. Complements the existing rustdoc links check by actually compiling the examples.
cargo test --doc --workspace --all-featureswithRUSTDOCFLAGS="-D warnings"to fail on any doc test warnings.Written for commit 7a534e1. Summary will update on new commits.