run CI for stable and nightly

Author: robamu

.github/workflows/ci.yml

@@ -138,9 +138,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: dtolnay/rust-toolchain@master
-        with:
-          toolchain: stable
+      - uses: dtolnay/rust-toolchain@nightly
+      - uses: dtolnay/rust-toolchain@stable
 
       - name: Cache
         uses: Swatinem/rust-cache@v2
@@ -150,7 +149,7 @@ jobs:
           cargo install svd2rust --path .
 
       - name: Check docs and clippy on generated PACs
-        run: cargo regress test -c ${{ matrix.chip }} --docs --clippy ${{ matrix.options }}
+        run: cargo regress test -c ${{ matrix.chip }} --docs-stable --docs-nightly --clippy ${{ matrix.options }}
 
   ci-serde:
     runs-on: ubuntu-latest

ci/svd2rust-regress/src/main.rs

@@ -94,9 +94,13 @@ pub struct TestAll {
     #[clap(long)]
     pub clippy: bool,
 
-    /// Check documentation build.
+    /// Check documentation build with stable.
     #[clap(long)]
-    pub docs: bool,
+    pub docs_stable: bool,
+
+    /// Check documentation build with nightly settings (docs.rs equivalent).
+    #[clap(long)]
+    pub docs_nightly: bool,
 
     /// Print all available test using the specified filters
     #[clap(long)]
@@ -154,9 +158,14 @@ pub struct Test {
     /// Check generated crate with clippy.
     #[arg(long)]
     pub clippy: bool,
-    /// Check documentation build.
-    #[arg(long)]
-    pub docs: bool,
+
+    /// Check documentation build with stable.
+    #[clap(long)]
+    pub docs_stable: bool,
+
+    /// Check documentation build with nightly settings (docs.rs equivalent).
+    #[clap(long)]
+    pub docs_nightly: bool,
 
     /// Path to an `svd2rust` binary, relative or absolute.
     /// Defaults to `target/release/svd2rust[.exe]` of this repository
@@ -210,7 +219,8 @@ impl Test {
             opts,
             &self.current_bin_path,
             self.clippy,
-            self.docs,
+            self.docs_stable,
+            self.docs_nightly,
             &self.passthrough_opts,
         )?;
         Ok(())
@@ -272,7 +282,8 @@ impl TestAll {
                 opt,
                 &self.current_bin_path,
                 self.clippy,
-                self.docs,
+                self.docs_stable,
+                self.docs_nightly,
                 &self.passthrough_opts,
             ) {
                 Ok(s) => {

ci/svd2rust-regress/src/svd_test.rs

@@ -159,7 +159,8 @@ impl TestCase {
         opts: &Opts,
         bin_path: &Path,
         run_clippy: bool,
-        run_docs: bool,
+        run_docs_stable: bool,
+        run_docs_nightly: bool,
         cli_passthrough_opts: &Option<Vec<String>>,
     ) -> Result<Option<Vec<PathBuf>>, TestError> {
         let (chip_dir, mut process_stderr_paths) = self
@@ -180,9 +181,9 @@ impl TestCase {
                 .with_context(|| "failed to check with cargo check")?;
             process_stderr_paths.push(cargo_check_err_file);
         }
-        if run_docs {
-            tracing::info!("Checking docs build");
-            let cargo_docs_err_file = path_helper_base(&chip_dir, &["cargo-docs.err.log"]);
+        if run_docs_nightly {
+            tracing::info!("Checking docs build with nightly");
+            let cargo_docs_err_file = path_helper_base(&chip_dir, &["cargo-docs-nightly.err.log"]);
             // Docs are built like docs.rs would build them. Additionally, build with all features.
 
             // Set the RUSTDOCFLAGS environment variable
@@ -195,7 +196,24 @@ impl TestCase {
                 .current_dir(&chip_dir)
                 .run_and_capture_stderr(
                     true,
-                    "cargo docs",
+                    "cargo docs nightly",
+                    &cargo_docs_err_file,
+                    &process_stderr_paths,
+                )
+                .with_context(|| "failed to generate docs with cargo docs")?;
+        }
+        if run_docs_stable {
+            tracing::info!("Checking docs build with stable");
+            let cargo_docs_err_file = path_helper_base(&chip_dir, &["cargo-docs-stable.err.log"]);
+            // Docs are built like docs.rs would build them. Additionally, build with all features.
+            Command::new("cargo")
+                .arg("+stable")
+                .arg("doc")
+                .arg("--all-features")
+                .current_dir(&chip_dir)
+                .run_and_capture_stderr(
+                    true,
+                    "cargo docs stable",
                     &cargo_docs_err_file,
                     &process_stderr_paths,
                 )