Merge pull request #40 from SkardiLabs/reduce_to_module_for_docs

Reduce to pipeline/engine/model to modules for single crate generation

Author: reluctanthero104

.github/workflows/ci.yml

@@ -29,13 +29,7 @@ jobs:
       - name: Install protoc
         run: sudo apt-get install -y protobuf-compiler
       - name: Build documentation
-        run: |
-          cargo doc \
-            --no-deps \
-            -p skardi-engine \
-            -p pipeline \
-            -p sources \
-            -p model
+        run: cargo doc --no-deps -p skardi
 
   test:
     name: Test

.github/workflows/docs.yml

@@ -47,19 +47,13 @@ jobs:
         run: sudo apt-get install -y protobuf-compiler
 
       - name: Build documentation
-        # Document library crates only; skip model's onnx feature (downloads native binaries).
         # --no-deps keeps the output focused on skardi's own APIs.
-        run: |
-          cargo doc \
-            --no-deps \
-            -p skardi-engine \
-            -p pipeline \
-            -p sources \
-            -p model
+        # sources is excluded from the facade crate until the lance git dep is resolved.
+        run: cargo doc --no-deps -p skardi
 
-      - name: Add redirect from root to skardi_engine
+      - name: Add redirect from root to skardi
         run: |
-          echo '<meta http-equiv="refresh" content="0; url=skardi_engine/index.html">' \
+          echo '<meta http-equiv="refresh" content="0; url=skardi/index.html">' \
             > target/doc/index.html
 
       - name: Upload Pages artifact

.github/workflows/release.yml

@@ -249,6 +249,37 @@ jobs:
             "${IMAGE}:${VERSION}-arm64"
           docker manifest push "${IMAGE}:latest"
 
+  publish:
+    name: "Publish to crates.io (${{ inputs.version }})"
+    needs: validate
+    runs-on: ubuntu-latest
+    if: ${{ !inputs.dry_run }}
+    env:
+      CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.version }}
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y protobuf-compiler
+
+      - name: Install Rust
+        run: rustup toolchain install stable
+
+      - uses: Swatinem/rust-cache@v2
+
+      - name: Publish skardi
+        run: cargo publish -p skardi
+
+      # skardi-sources is not published yet: it depends on lance via git which crates.io disallows.
+      # Once lance v4 is stable on crates.io, replace the git deps in Cargo.toml, add it to
+      # the skardi facade crate, and publish with:
+      #   cargo publish -p skardi-sources  (before cargo publish -p skardi)
+
   release:
     name: "Create Release (${{ inputs.version }})"
     needs: [build, docker-manifest]

Cargo.lock

@@ -9,10 +9,8 @@ license = "Apache-2.0"
 
 [workspace]
 members = [ "crates/cli",
-            "crates/engine",
+            "crates/skardi",
             "crates/sources",
-            "crates/model",
-            "crates/pipeline",
             "crates/server"]
 
 resolver = "2"
@@ -64,7 +62,6 @@ rstest = "0.25.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 serde_yaml = "0.9"
-skardi-engine = { path = "crates/engine" }
 sqlparser = "0.55.0"
 sqlx = { version = "0.8", default-features = false, features = ["runtime-tokio", "tls-rustls", "postgres"] }
 tempfile = "3.23.0"

Cargo.toml

@@ -26,7 +26,7 @@ object_store = { workspace = true, features = ["aws", "gcp", "azure", "http"] }
 serde = { workspace = true }
 serde_json = { workspace = true }
 serde_yaml = { workspace = true }
-sources = { path = "../sources" }
+sources = { package = "skardi-sources", path = "../sources" }
 tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }
 url = { workspace = true }