You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Check Rustdoc warnings for the compiler in PR CI #106624
Docs (and specially intra-doc-links) are easy to get wrong and rarely tested locally, causing many rollups to fail. We should check them in CI as well to catch mistakes early.
The most recent case I've seen was this: #100036 (comment)
where broken docs broke a try build while PR CI was green (that wasn't an intra doc link though but still docs)
Ah ok, this is specifically about rustdoc warnings, not broken links. That's definitely doable to do, we can shove x doc --stage 0 compiler into mingw-check :) it doesn't need to build the compiler at all, only check it.
Apparently ./x test linkchecker doesn't actually build the compiler docs (or tool docs) when the build.compiler-docs flag isn't set in config.toml. I don't know if this is a bug or a feature, but we could just set the flag for CI here:
Activity
[-]Check docs CI[/-][+]Check docs in CI[/+]albertlarsan68 commentedon Jan 9, 2023
@rustbot claim
the8472 commentedon Jan 9, 2023
But
./x test linkcheckeralready runs in PR CIjyn514 commentedon Jan 10, 2023
cc #106117
maybe linkchecker is missing some cases?
Noratrieb commentedon Jan 10, 2023
The most recent case I've seen was this: #100036 (comment)
where broken docs broke a try build while PR CI was green (that wasn't an intra doc link though but still docs)
jyn514 commentedon Jan 10, 2023
Ah ok, this is specifically about rustdoc warnings, not broken links. That's definitely doable to do, we can shove
x doc --stage 0 compilerinto mingw-check :) it doesn't need to build the compiler at all, only check it.[-]Check docs in CI[/-][+]Check Rustdoc warnings for the compiler in PR CI[/+]lukas-code commentedon Jan 11, 2023
Apparently
./x test linkcheckerdoesn't actually build the compiler docs (or tool docs) when thebuild.compiler-docsflag isn't set inconfig.toml. I don't know if this is a bug or a feature, but we could just set the flag for CI here:rust/src/ci/docker/host-x86_64/x86_64-gnu-llvm-13/Dockerfile
Lines 45 to 49 in 002eccc
lukas-code commentedon Jan 11, 2023
Rollup merge of rust-lang#106670 - albertlarsan68:check-docs-in-pr-ci…