Unnamed repository; edit this file 'description' to name the repository.
Merge pull request #19315 from snprajwal/ci-xtask
fix(codegen): do not generate docs with `--check`
| -rw-r--r-- | xtask/src/codegen/assists_doc_tests.rs | 5 | ||||
| -rw-r--r-- | xtask/src/codegen/diagnostics_docs.rs | 14 | ||||
| -rw-r--r-- | xtask/src/codegen/feature_docs.rs | 6 |
3 files changed, 18 insertions, 7 deletions
diff --git a/xtask/src/codegen/assists_doc_tests.rs b/xtask/src/codegen/assists_doc_tests.rs index 1bb7845b9c..dd55d06bd3 100644 --- a/xtask/src/codegen/assists_doc_tests.rs +++ b/xtask/src/codegen/assists_doc_tests.rs @@ -53,6 +53,11 @@ r#####" ); } + // Do not generate assists manual when run with `--check` + if check { + return; + } + { // Generate assists manual. Note that we do _not_ commit manual to the // git repo. Instead, `cargo xtask release` runs this test before making diff --git a/xtask/src/codegen/diagnostics_docs.rs b/xtask/src/codegen/diagnostics_docs.rs index 7858e9ae1b..4a47a5f6aa 100644 --- a/xtask/src/codegen/diagnostics_docs.rs +++ b/xtask/src/codegen/diagnostics_docs.rs @@ -10,13 +10,15 @@ use crate::{ pub(crate) fn generate(check: bool) { let diagnostics = Diagnostic::collect().unwrap(); - if !check { - let contents = - diagnostics.into_iter().map(|it| it.to_string()).collect::<Vec<_>>().join("\n\n"); - let contents = add_preamble(crate::flags::CodegenType::DiagnosticsDocs, contents); - let dst = project_root().join("docs/book/src/diagnostics_generated.md"); - fs::write(dst, contents).unwrap(); + // Do not generate docs when run with `--check` + if check { + return; } + let contents = + diagnostics.into_iter().map(|it| it.to_string()).collect::<Vec<_>>().join("\n\n"); + let contents = add_preamble(crate::flags::CodegenType::DiagnosticsDocs, contents); + let dst = project_root().join("docs/book/src/diagnostics_generated.md"); + fs::write(dst, contents).unwrap(); } #[derive(Debug)] diff --git a/xtask/src/codegen/feature_docs.rs b/xtask/src/codegen/feature_docs.rs index c10ada2533..170de5db9a 100644 --- a/xtask/src/codegen/feature_docs.rs +++ b/xtask/src/codegen/feature_docs.rs @@ -8,8 +8,12 @@ use crate::{ util::list_rust_files, }; -pub(crate) fn generate(_check: bool) { +pub(crate) fn generate(check: bool) { let features = Feature::collect().unwrap(); + // Do not generate docs when run with `--check` + if check { + return; + } let contents = features.into_iter().map(|it| it.to_string()).collect::<Vec<_>>().join("\n\n"); let contents = add_preamble(crate::flags::CodegenType::FeatureDocs, contents); let dst = project_root().join("docs/book/src/features_generated.md"); |