Skip to content

[synaptic-mesh] GH#34 — crates.io packaging metadata for 0.3.0 #34

Description

@rmems

Goal

Prepare synaptic-mesh 0.3.0 as the first crates.io package. Modelled on axon-encoder#60. Do not publish in this issue — dry-run only. Publish is the sibling release issue.

Cargo.toml packaging

  • Bump version = "0.3.0"
  • Add documentation = "https://docs.rs/synaptic-mesh"
  • Add explicit readme = "README.md"
  • Expand exclude to /.github/, /qodana.yaml, /REVIEW.md (keep /docs/ excluded)
  • Do not add authors
  • Do not duplicate repository as homepage
  • Keep existing keywords/categories unless a slug is invalid

README

  • Primary install path:
[dependencies]
synaptic-mesh = "0.3"
  • Git dependency marked as bleeding-edge alternative
  • Describe 0.3.0 as experimental pre-1.0

Publication verification (dry-run)

  • cargo fmt --check
  • cargo clippy --all-targets --all-features -- -D warnings
  • cargo test --locked
  • cargo doc --no-deps --all-features with no warnings
  • cargo package --list contains only intended consumer files
  • cargo package --locked succeeds
  • cargo publish --dry-run --locked succeeds without warnings

Non-goals

  • Real cargo publish (next issue)
  • Optional serde feature, examples, #[non_exhaustive] (v0.4.0)

Milestone

v0.3.0 — First crates.io

Metadata

Metadata

Assignees

Labels

choredocumentationImprovements or additions to documentation

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions