Workspace hack (#265)

It should reduce CI times when compiling the entire workspace vs
compiling a single package.

.github/workflows/workspace-hack.yml

@@ -0,0 +1,35 @@
+name: Workspace hack
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      # Check https://docs.rs/cargo-hakari/0.9.29/cargo_hakari/#installation
+      # to learn how to install cargo-hakari locally
+      - name: Install cargo-hakari
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-hakari
+      - name: Verify workspace-hack
+        run: |
+          cd libs
+          # Check that my-workspace-hack's Cargo.toml is up-to-date
+          # If this fails, run `cargo hakari generate` to fix it
+          cargo hakari generate --diff  
+          # Check that all workspace crates depend on my-workspace-hack
+          # If this fails, run `cargo hakari manage-deps` to fix it
+          cargo hakari manage-deps --dry-run

libs/.config/hakari.toml

@@ -0,0 +1,25 @@
+# This file contains settings for `cargo hakari`.
+# See https://docs.rs/cargo-hakari/latest/cargo_hakari/config for a full list of options.
+
+hakari-package = "workspace_hack"
+
+# Format version for hakari's output. Version 4 requires cargo-hakari 0.9.22 or above.
+dep-format-version = "4"
+
+# Setting workspace.resolver = "2" in the root Cargo.toml is HIGHLY recommended.
+# Hakari works much better with the new feature resolver.
+# For more about the new feature resolver, see:
+# https://blog.rust-lang.org/2021/03/25/Rust-1.51.0.html#cargos-new-feature-resolver
+resolver = "2"
+
+# Add triples corresponding to platforms commonly used by developers here.
+# https://doc.rust-lang.org/rustc/platform-support.html
+platforms = [
+    # "x86_64-unknown-linux-gnu",
+    # "x86_64-apple-darwin",
+    # "aarch64-apple-darwin",
+    # "x86_64-pc-windows-msvc",
+]
+
+# Write out exact versions rather than a semver range. (Defaults to false.)
+# exact-versions = true

libs/Cargo.toml

@@ -1,5 +1,5 @@
 [workspace]
-members = ["./pavex*", "generate_from_path", "persist_if_changed"]
+members = ["./pavex*", "generate_from_path", "persist_if_changed", "workspace_hack"]
 resolver = "2"
 
 [workspace.package]

libs/generate_from_path/Cargo.toml

@@ -20,3 +20,4 @@ indicatif = "0.17.7"
 walkdir = "2.4.0"
 sanitize-filename = "0.5"
 regex = "1.10.2"
+workspace_hack = { version = "0.1", path = "../workspace_hack" }

libs/pavex/Cargo.toml

@@ -66,6 +66,7 @@ hyper = { version = "1", features = ["full"], optional = true }
 hyper-util = { version = "0.1", features = ["tokio", "server", "server-auto"], optional = true }
 socket2 = { version = "0.5.3", optional = true }
 smallvec = "1"
+workspace_hack = { version = "0.1", path = "../workspace_hack" }
 
 [dev-dependencies]
 tokio = { version = "1", features = ["macros"] }

libs/pavex_bp_schema/Cargo.toml

@@ -10,3 +10,4 @@ license.workspace = true
 [dependencies]
 serde = { version = "1", features = ["derive"] }
 pavex_reflection = { path = "../pavex_reflection", version = "=0.1.30" }
+workspace_hack = { version = "0.1", path = "../workspace_hack" }

libs/pavex_cli/Cargo.toml

@@ -54,6 +54,7 @@ secrecy = { version = "0.8.0", features = ["serde"] }
 clap-stdin = "0.4.0"
 owo-colors = "4.0.0"
 anstyle = "1.0.6"
+workspace_hack = { version = "0.1", path = "../workspace_hack" }
 
 [dev-dependencies]
 pavex_test_runner = { path = "../pavex_test_runner" }

libs/pavex_cli_client/Cargo.toml

@@ -11,3 +11,4 @@ license.workspace = true
 anyhow = "1"
 pavex = { path = "../pavex", version = "0.1.30" }
 thiserror = "1.0.56"
+workspace_hack = { version = "0.1", path = "../workspace_hack" }

libs/pavex_macros/Cargo.toml

@@ -14,6 +14,7 @@ proc-macro = true
 proc-macro2 = "1.0"
 quote = "1.0"
 syn = "2.0"
+workspace_hack = { version = "0.1", path = "../workspace_hack" }
 
 [dev-dependencies]
 trybuild = "1.0"

libs/pavex_miette/Cargo.toml

@@ -16,3 +16,4 @@ supports-hyperlinks = { version = "3.0.0" }
 supports-color = { version = "3.0.0" }
 supports-unicode = { version = "3.0.0" }
 terminal_size = { version = "0.3" }
+workspace_hack = { version = "0.1", path = "../workspace_hack" }

libs/pavex_reflection/Cargo.toml

@@ -9,3 +9,4 @@ license.workspace = true
 
 [dependencies]
 serde = { version = "1", features = ["derive"] }
+workspace_hack = { version = "0.1", path = "../workspace_hack" }

libs/pavex_test_runner/Cargo.toml

@@ -37,3 +37,4 @@ globwalk = "0.9.1"
 tracing-subscriber = { version = "0.3", features = ["env-filter", "fmt"] }
 regex = "1.10.2"
 once_cell = "1.19.0"
+workspace_hack = { version = "0.1", path = "../workspace_hack" }

libs/pavex_tracing/Cargo.toml

@@ -12,3 +12,4 @@ readme = "README.md"
 [dependencies]
 tracing = { version = "0.1", default-features = false, features = ["std"] }
 pavex = { version = "0.1.30", path = "../pavex" }
+workspace_hack = { version = "0.1", path = "../workspace_hack" }

libs/pavexc/Cargo.toml

@@ -60,3 +60,4 @@ r2d2 = "0.8"
 bincode = "1"
 rayon = "1.7"
 num_cpus = "1.15.0"
+workspace_hack = { version = "0.1", path = "../workspace_hack" }

libs/pavexc_cli/Cargo.toml

@@ -31,6 +31,7 @@ ron = "0.8"
 generate_from_path = { path = "../generate_from_path", version = "0.1.30" }
 tempfile = "3.9.0"
 better-panic = "0.3.0"
+workspace_hack = { version = "0.1", path = "../workspace_hack" }
 
 [build-dependencies]
 vergen = { workspace = true }

libs/pavexc_cli_client/Cargo.toml

@@ -11,3 +11,4 @@ license.workspace = true
 anyhow = "1"
 pavex = { path = "../pavex", version = "0.1.30" }
 thiserror = "1.0.56"
+workspace_hack = { version = "0.1", path = "../workspace_hack" }

libs/persist_if_changed/Cargo.toml

@@ -12,3 +12,4 @@ tracing = "0.1"
 fs-err = "2.7"
 sha2 = "0.10"
 anyhow = "1"
+workspace_hack = { version = "0.1", path = "../workspace_hack" }

libs/workspace_hack/.gitattributes

@@ -0,0 +1,4 @@
+# Avoid putting conflict markers in the generated Cargo.toml file, since their presence breaks
+# Cargo.
+# Also do not check out the file as CRLF on Windows, as that's what hakari needs.
+Cargo.toml merge=binary -crlf