ci: run doctests for unstable APIs #4562
Merged
+5
−2
Conversation
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
It turns out that the CI job for testing `tokio_unstable` features isn't actually running doctests for `tokio_unstable`, just lib and integration tests. This is because RustDoc is responsible for running doctests, and it needs the unstable cfg passed to it separately from `RUSTFLAGS`. This means that if the examples for unstable APIs are broken, CI won't catch this, which is not great! This commit changes the `test-unstable` CI job to pass `--cfg tokio_unstable` in `RUSTDOCFLAGS` as well as `RUSTFLAGS`. This way, doctests for unstable APIs should actually run.
Noah-Kennedy
approved these changes
Mar 11, 2022
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
|
cool, found a typo in the runtime metrics doctests --- the system works! https://github.com/tokio-rs/tokio/runs/5515810817?check_suite_focus=true |
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Darksonn
added
T-docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
It turns out that the CI job for testing
tokio_unstablefeatures isn'tactually running doctests for
tokio_unstable, just lib and integrationtests. This is because RustDoc is responsible for running doctests, and
it needs the unstable cfg passed to it separately from
RUSTFLAGS.This means that if the examples for unstable APIs are broken, CI won't
catch this, which is not great!
This commit changes the
test-unstableCI job to pass--cfg tokio_unstableinRUSTDOCFLAGSas well asRUSTFLAGS. This way,doctests for unstable APIs should actually run.