Preparation for crates.io publishing

.github/workflows/build.yml

@@ -41,6 +41,9 @@ jobs:
       - name: Run tests
         run: cargo test --target=${{ matrix.target.arch }} --verbose
         if: ${{ matrix.target.skip-test != true }}
+      - name: Publish dry-run
+        run: cargo publish --dry-run -p csaf-rs --target=${{ matrix.target.arch }} --verbose
+        if: ${{ matrix.target.skip-test != true }}
       - name: Archive csaf-validator (${{ matrix.target.arch }})
         uses: actions/upload-artifact@v4
         with:

Cargo.toml

@@ -1,3 +1,3 @@
 [workspace]
-members = ["csaf-validator", "csaf-lib"]
+members = ["csaf-validator", "csaf-rs"]
 resolver = "2"

csaf-lib/Cargo.toml → csaf-rs/Cargo.toml

@@ -1,6 +1,11 @@
 [package]
-name = "csaf-lib"
-version = "0.1.0"
+name = "csaf-rs"
+description = "A parser for the CSAF standard written in Rust"
+license = "Apache-2.0"
+repository = "http://github.com/csaf-poc/csaf-rust"
+keywords = ["csaf"]
+readme = "../README.md"
+version = "0.1.2"
 edition = "2021"
 
 [dependencies]

csaf-lib/build.rs → csaf-rs/build.rs

@@ -18,6 +18,21 @@ pub enum BuildError {
 }
 
 fn main() -> Result<(), BuildError> {
+    // We only need to generate these files as part of our cargo build process,
+    // not if we are publishing or getting built by cargo from a crates.io
+    // package. This is because the files are generated from the JSON schema
+    // files, which are not included in the published package.
+    let manifest_dir = Path::new(env!("CARGO_MANIFEST_DIR"));
+    if manifest_dir.to_string_lossy().contains("target/package") {
+        // If we're in target/package/<version>, we don't need to generate the files
+        // because they are already generated in the package.
+        return Ok(());
+    } else if manifest_dir.to_string_lossy().contains("crates.io") {
+        // If we're in a crates.io folder we don't need to generate the files
+        // because they are already generated in the debug build.
+        return Ok(());
+    }
+
     build(
         "./src/csaf/csaf2_0/csaf_json_schema.json",
         "csaf/csaf2_0/schema.rs",
@@ -42,8 +57,8 @@ fn main() -> Result<(), BuildError> {
     Ok(())
 }
 
-fn build(input: &str, output: &str, no_date_time: bool) -> Result<(), BuildError> {
-    let content = fs::read_to_string(input)?;
+fn build(input: &str, output: &str, no_date_time: bool) -> Result<(), BuildError> {    
+    let content = fs::read_to_string(&input)?;
     let mut schema_value = serde_json::from_str(&content)?;
     if no_date_time {
         // Recursively search for "format": "date-time" and remove this format

csaf-validator/Cargo.toml

@@ -1,9 +1,14 @@
 [package]
 name = "csaf-validator"
-version = "0.1.0"
+description = "A validator for the CSAF standard written in Rust"
+license = "Apache-2.0"
+repository = "http://github.com/csaf-poc/csaf-rust"
+keywords = ["csaf"]
+readme = "../README.md"
+version = "0.1.2"
 edition = "2021"
 
 [dependencies]
-csaf-lib = { path = "../csaf-lib" }
+csaf-rs = { path = "../csaf-rs", version = "0.1.2" }
 anyhow = "1.0.93"
 clap = { version = "4.5.23", features = ["derive"] }

csaf-validator/src/main.rs

@@ -1,8 +1,8 @@
 use std::str::FromStr;
 use anyhow::{bail, Result};
-use csaf_lib::csaf::csaf2_0::loader::load_document as load_document_2_0;
-use csaf_lib::csaf::csaf2_1::loader::load_document as load_document_2_1;
-use csaf_lib::csaf::validation::{validate_by_preset, validate_by_test, Validatable, ValidationPreset};
+use csaf_rs::csaf::csaf2_0::loader::load_document as load_document_2_0;
+use csaf_rs::csaf::csaf2_1::loader::load_document as load_document_2_1;
+use csaf_rs::csaf::validation::{validate_by_preset, validate_by_test, Validatable, ValidationPreset};
 use clap::Parser;
 
 /// A validator for CSAF documents