Include kicad drc json in release (#519)

* Include kicad drc json in release

* Fix snapshot tests, add changelog

Author: akhilles

CHANGELOG.md

@@ -8,6 +8,10 @@ and this project adheres to Semantic Versioning (https://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+- `pcb release` now includes `drc.json` in the release archive containing the full KiCad DRC report.
+
 ### Changed
 
 - KiCad layout discovery no longer assumes `layout.kicad_pcb`; it now discovers a single top-level `.kicad_pro` (preferred) or `.kicad_pcb` in the layout directory and errors on ambiguity.

crates/pcb-kicad/src/lib.rs

@@ -319,30 +319,31 @@ where
 /// # Arguments
 /// * `pcb_path` - Path to the .kicad_pcb file to check
 /// * `diagnostics` - Diagnostics collection to add violations to
+/// * `output` - Path to write the raw KiCad DRC JSON report to
 ///
 /// # Example
 /// ```no_run
 /// use pcb_kicad::run_drc;
 /// use pcb_zen_core::Diagnostics;
 /// let mut diagnostics = Diagnostics::default();
-/// run_drc("layout/layout.kicad_pcb", &mut diagnostics).unwrap();
+/// let output = tempfile::NamedTempFile::new().unwrap();
+/// run_drc("layout/layout.kicad_pcb", &mut diagnostics, output.path()).unwrap();
 /// if diagnostics.error_count() > 0 {
 ///     eprintln!("DRC errors found!");
 /// }
 /// ```
-pub fn run_drc(pcb_path: impl AsRef<Path>, diagnostics: &mut Diagnostics) -> Result<()> {
+pub fn run_drc(
+    pcb_path: impl AsRef<Path>,
+    diagnostics: &mut Diagnostics,
+    output: &Path,
+) -> Result<()> {
     check_kicad_installed()?;
 
     let pcb_path = pcb_path.as_ref();
     if !pcb_path.exists() {
         anyhow::bail!("PCB file not found: {}", pcb_path.display());
     }
 
-    // Create a temporary file for the JSON output
-    let temp_file =
-        NamedTempFile::new().context("Failed to create temporary file for DRC output")?;
-    let temp_path = temp_file.path();
-
     // Run kicad-cli pcb drc with JSON output
     KiCadCliBuilder::new()
         .command("pcb")
@@ -352,13 +353,13 @@ pub fn run_drc(pcb_path: impl AsRef<Path>, diagnostics: &mut Diagnostics) -> Res
         .arg("--severity-all") // Report all severities (errors and warnings)
         .arg("--severity-exclusions") // Include violations excluded by user in KiCad
         .arg("--output")
-        .arg(temp_path.to_string_lossy())
+        .arg(output.to_string_lossy())
         .arg(pcb_path.to_string_lossy())
         .run()
         .context("Failed to run KiCad DRC")?;
 
     // Parse and add to diagnostics
-    let report = drc::DrcReport::from_file(temp_path).context("Failed to parse DRC report")?;
+    let report = drc::DrcReport::from_file(output).context("Failed to parse DRC report")?;
     report.add_to_diagnostics(diagnostics, &pcb_path.to_string_lossy());
     Ok(())
 }

crates/pcb/src/layout.rs

@@ -124,7 +124,8 @@ pub fn execute(mut args: LayoutArgs) -> Result<()> {
     // Run DRC in check mode
     if args.check {
         let spinner = Spinner::builder(format!("{file_name}: Running DRC checks")).start();
-        pcb_kicad::run_drc(&pcb_file, &mut diagnostics)?;
+        let drc_output = tempfile::NamedTempFile::new()?;
+        pcb_kicad::run_drc(&pcb_file, &mut diagnostics, drc_output.path())?;
         spinner.finish();
     }
 

crates/pcb/src/release.rs

@@ -1510,8 +1510,9 @@ fn run_kicad_drc(info: &ReleaseInfo, spinner: &Spinner) -> Result<()> {
         &mut diagnostics,
     )?;
 
-    // Run DRC and render all diagnostics
-    pcb_kicad::run_drc(&kicad_pcb_path, &mut diagnostics)?;
+    // Run DRC, writing raw KiCad JSON report to staging directory
+    let drc_json_path = info.staging_dir.join("drc.json");
+    pcb_kicad::run_drc(&kicad_pcb_path, &mut diagnostics, &drc_json_path)?;
     spinner.suspend(|| crate::drc::render_diagnostics(&mut diagnostics, &info.suppress));
 
     // Fail if there are errors

crates/pcb/tests/release.rs

@@ -249,6 +249,7 @@ fn test_publish_board_full() {
             "manufacturing/*.html",
             "**/vendor/**",
             "**/build/**",
+            "**/drc.json",
         ])
         .init_git()
         .commit("Initial commit");

crates/pcb/tests/tag.rs

@@ -47,6 +47,7 @@ fn test_publish_board_simple_workspace() {
             "**/manufacturing/**",
             "**/3d/**",
             "**/bom/**",
+            "**/drc.json",
         ])
         .init_git()
         .commit("Initial commit");