Enable publishing the Voro crates to crates.io#81
Merged
Conversation
The README documents `cargo install voro` as the from-source install path, but that only resolves once the crates are on crates.io. Wire up publishing so the command works. - Flip `release.toml` `publish = false` -> `true`; both crates publish in lockstep, `voro-core` first so `voro`'s dependency resolves against the registry. - Give `voro`'s `voro-core` dependency a version requirement alongside its path, so both a path build and a published build resolve. crates.io rejects path-only dependencies. - Add crates.io-required/recommended metadata (`description`, `readme`, `keywords`, `categories`) to both crates; `voro-core` had no description. - Document the crates.io publish step and the `cargo login` / `CARGO_REGISTRY_TOKEN` requirement in the README, and correct the now-false "Neither crate is published to crates.io" note in `release.toml`. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016c3RHYYkoqmmedJVhpvFj1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Enable publishing the Voro crates to crates.io so
cargo install voro(documented in the README) resolves.Changes:
Publish path decision: publishing runs locally from cargo release (consistent with the existing operator-driven flow where push = false and the operator pushes the tag), not from CI — the cargo-dist release.yml only builds/publishes GitHub artifacts and is left untouched. The operator needs a crates.io token in the environment.
Verification: cargo build/fmt --check/clippy -D warnings/test --workspace all pass (193 tests). cargo package -p voro-core succeeds and includes README.md + all metadata. cargo package -p voro fails locally only because voro-core 0.1.0 is not yet on the registry — the expected ordering that cargo-release handles by publishing voro-core first; removing the version requirement instead triggers cargo's 'all dependencies must have a version requirement' error, confirming the version field is both correct and mandatory. cargo metadata confirms both manifests expose valid description/readme/keywords/categories.
Note: this change enables publishing but does not itself publish; 'cargo install voro' starts working once the operator runs the first 'cargo release' with a token configured. No remaining docs claim the crates are unpublished (the only such statement was the release.toml comment; CHANGELOG.md never carried one).