Add rustdoc CI check #5041
Add rustdoc CI check #5041
Conversation
|
|
.github/workflows/rustdoc_check.yml
Outdated
| RUSTFLAGS: -D warnings | ||
| RUSTDOCFLAGS: --document-private-items --enable-index-page --show-type-layout --generate-link-to-definition -Zunstable-options |
There was a problem hiding this comment.
Looks like there was a warning in the rustdoc check job, but it didn't cause the job to fail. is that the right behavior?
Nah we'd definitely want the job to fail. Does moving -D warnings to rust doc flags make a different? Otherwise perhaps a set -e?
There was a problem hiding this comment.
You were right. I needed to move the -D warnings option to the RUSTDOCFLAGS! I just did, and the CI job now passes without issuing any warnings since it looks like you fixed the doc warning in 051e2b4
|
Also, I'd like to give you triage permissions so that you have access to label issues, if that's something you'd be interested in (and as always, no worries if not!). Feel free to ping me in Discord if you have questions |
Resolves 5038 rust-lang/rust builds now document rustfmt (rust-lang/rust#87119). The build process is updated with doc checks to ensure that rustfmt doesn't introduce warnings. Warnings are treated as hard errors in rust-lang/rust and won't show until bors tests the changes (refs rust-lang/rust#90087).
|
I'm honored thank you! I'd definitely be interested in taking on some of the triage work. I have a few questions so I'll ping you on discord! |
|
Thank you! |
Resolves #5038
rust-lang/rust builds now document rustfmt (rust-lang/rust#87119). The
build process is updated with doc checks to ensure that rustfmt doesn't
introduce warnings.
Warnings are treated as hard errors in rust-lang/rust and won't show
until bors tests the changes (refs rust-lang/rust#90087).