Add doctests (as nextest doesn't do these yet) #101
Merged
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
sophokles73
reviewed
May 14, 2024
.github/workflows/check.yaml
Outdated
| - name: Run doc tests | ||
| run: | | ||
| cargo test --doc --all-features |
There was a problem hiding this comment.
if we create JSON output from nextest, maybe we also want to create JSON output here?
There was a problem hiding this comment.
Agree - forgot to take over that bit.
sophokles73
reviewed
May 14, 2024
.github/workflows/check.yaml
Outdated
| - name: Run doc tests | ||
| run: | | ||
| cargo test --doc --all-features > doctestresults--all-features.json |
There was a problem hiding this comment.
this will not produce JSON output
for that, you need to provide some command line params:
RUSTC_BOOTSTRAP=1 cargo test --doc -- -Z unstable-options --format json --report-time > doctestresults--all-features.jsonThere was a problem hiding this comment.
I really shouldn't be doing this while being at a conference...
.github/workflows/check.yaml
Outdated
| name: doctest-results | ||
| path: doctestresults--all-features.json | ||
|
|
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.
As has come up recently, our check workflow doesn't yet run doctests. So this is adding an explicit doctest step.
(refer to last bullet in #84)