fix: make the 0.1.0 release publishable (#16)

Author: tisonkun

CHANGELOG.md

@@ -40,6 +40,7 @@ All notable changes to this project will be documented in this file.
 
 ### Bug fixes
 
+* Package and verify the unpublished main and derive crates together so a new release does not require its derive version to exist on crates.io first.
 * Preserve qualified Serde function paths such as `<T as Trait>::function` as parseable Rust token streams.
 * Match Serde's fixed-array coverage and bounds: lengths above 32 no longer claim shape support, while zero-length arrays no longer require their unobserved element type to implement a shape trait, including inside derived generic containers.
 * Match Serde's deserialization bounds for tree and hash collections so a shape implementation is exposed only when the corresponding collection can actually deserialize.
@@ -52,6 +53,7 @@ All notable changes to this project will be documented in this file.
 
 ### Improvements
 
+* Clarify that shape derives and `serde_shape` attributes provide reflection metadata without implementing or changing Serde's runtime traits.
 * Point README and crate-level installation examples at the upcoming `0.1.0` release.
 * State the graph-local `ShapeId` ownership contract accurately instead of claiming that lookups can detect an in-bounds id copied from another graph.
 * Add `definition_for` to both graph types so walkers can resolve a `ShapeRef::Definition` without repeating a match and id lookup.

Cargo.lock

@@ -33,8 +33,8 @@ rust-version = "1.85.0"
 
 [workspace.dependencies]
 # workspace dependencies
-serde-shape = { version = "0.0.1", path = "serde-shape" }
-serde-shape-derive = { version = "=0.0.1", path = "serde-shape-derive" }
+serde-shape = { version = "0.1.0", path = "serde-shape" }
+serde-shape-derive = { version = "=0.1.0", path = "serde-shape-derive" }
 
 # crates.io dependencies
 clap = { version = "4.6.1" }

Cargo.toml

@@ -36,6 +36,8 @@ Enable `std` when your reflected types use shapes provided only by the Rust stan
 serde-shape = { version = "0.1.0", features = ["derive", "std"] }
 ```
 
+The shape derives are independent of Serde's `Serialize` and `Deserialize` derives: they neither implement nor require those traits. Derive both sets when a type must also perform actual serialization or deserialization. Likewise, `serde_shape` attributes describe reflection metadata only and do not change Serde's runtime behavior.
+
 ## Motivation
 
 Use `serde-shape` when Serde already defines the contract you care about, but you also need to inspect that contract as data.

README.md

@@ -14,7 +14,7 @@
 
 [package]
 name = "serde-shape-derive"
-version = "0.0.1"
+version = "0.1.0"
 
 categories = ["development-tools", "encoding"]
 description = "Procedural macro implementation for the serde-shape crate."

serde-shape-derive/Cargo.toml

@@ -14,7 +14,7 @@
 
 [package]
 name = "serde-shape"
-version = "0.0.1"
+version = "0.1.0"
 
 categories = ["development-tools", "encoding"]
 description = "Build inspectable graphs of Serde serialization and deserialization shapes."

serde-shape/Cargo.toml

@@ -41,6 +41,10 @@
 //! ```
 //!
 //! The crate is `no_std` by default and requires `alloc`.
+//! The shape derives are independent of Serde's `Serialize` and `Deserialize` derives: they
+//! neither implement nor require those traits. Derive both sets when a type must also perform
+//! actual serialization or deserialization. `serde_shape` attributes affect reflection metadata
+//! only; they do not change Serde's runtime behavior.
 //!
 //! # Quick start
 //!

serde-shape/src/lib.rs

@@ -26,7 +26,6 @@ release = false
 
 [dependencies]
 clap = { workspace = true, features = ["derive"] }
-serde_json = { workspace = true }
 which = { workspace = true }
 
 [lints]

xtask/Cargo.toml

@@ -12,7 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use std::fs;
 use std::path::Path;
 use std::process::Command as StdCommand;
 
@@ -73,16 +72,7 @@ struct CommandPackage {
 
 impl CommandPackage {
     fn run(self) {
-        let main_version = package_version("serde-shape");
-        let derive_version = package_version("serde-shape-derive");
-
-        run_command(make_package_cmd("serde-shape-derive", self.locked));
-
-        // Cargo would otherwise verify main against an already-published derive crate with the
-        // same version. Unpack the archive and patch the two packaged crates together instead.
-        run_command(make_package_archive_cmd("serde-shape", self.locked));
-        unpack_package_archive("serde-shape", &main_version);
-        run_command(make_verify_main_package_cmd(&main_version, &derive_version));
+        run_command(make_package_cmd(self.locked));
     }
 }
 
@@ -182,77 +172,22 @@ fn make_build_cmd(locked: bool) -> StdCommand {
     cmd
 }
 
-fn make_package_cmd(package: &str, locked: bool) -> StdCommand {
+fn make_package_cmd(locked: bool) -> StdCommand {
     let mut cmd = find_command("cargo");
-    cmd.args(["package", "--package", package, "--all-features"]);
+    cmd.args([
+        "package",
+        "--package",
+        "serde-shape-derive",
+        "--package",
+        "serde-shape",
+        "--all-features",
+    ]);
     if locked {
         cmd.arg("--locked");
     }
     cmd
 }
 
-fn make_package_archive_cmd(package: &str, locked: bool) -> StdCommand {
-    let mut cmd = make_package_cmd(package, locked);
-    cmd.arg("--no-verify");
-    cmd
-}
-
-fn unpack_package_archive(package: &str, version: &str) {
-    let package_root = workspace_dir().join("target/package");
-    let package_dir = package_root.join(format!("{package}-{version}"));
-    if package_dir.exists() {
-        fs::remove_dir_all(&package_dir).expect("failed to remove stale package directory");
-    }
-
-    let mut cmd = find_command("tar");
-    cmd.arg("-xzf")
-        .arg(package_root.join(format!("{package}-{version}.crate")))
-        .arg("-C")
-        .arg(package_root);
-    run_command(cmd);
-}
-
-fn make_verify_main_package_cmd(main_version: &str, derive_version: &str) -> StdCommand {
-    let package_dir = workspace_dir()
-        .join("target/package")
-        .join(format!("serde-shape-{main_version}"));
-    let derive_dir = workspace_dir()
-        .join("target/package")
-        .join(format!("serde-shape-derive-{derive_version}"));
-    let derive_dir = serde_json::to_string(&derive_dir.to_string_lossy()).unwrap();
-    let patch = format!("patch.crates-io.serde-shape-derive.path={derive_dir}");
-
-    let mut cmd = find_command("cargo");
-    cmd.args(["check", "--manifest-path"])
-        .arg(package_dir.join("Cargo.toml"))
-        .args(["--all-features", "--config", &patch]);
-    cmd
-}
-
-fn package_version(package: &str) -> String {
-    let mut cmd = find_command("cargo");
-    cmd.args(["metadata", "--no-deps", "--format-version", "1"]);
-    let output = cmd.output().expect("failed to read workspace metadata");
-    assert!(
-        output.status.success(),
-        "cargo metadata failed: {}",
-        String::from_utf8_lossy(&output.stderr)
-    );
-
-    let metadata: serde_json::Value =
-        serde_json::from_slice(&output.stdout).expect("cargo metadata should be valid JSON");
-    metadata["packages"]
-        .as_array()
-        .and_then(|packages| {
-            packages
-                .iter()
-                .find(|candidate| candidate["name"] == package)
-        })
-        .and_then(|package| package["version"].as_str())
-        .unwrap_or_else(|| panic!("package {package} not found in cargo metadata"))
-        .to_owned()
-}
-
 fn make_test_cmd(no_capture: bool, package: &str, features: &[&str]) -> StdCommand {
     let mut cmd = find_command("cargo");
     cmd.args(["test", "-p", package, "--no-default-features"]);