Skip to content

chore: prepare 0.1.0 release for crates.io#9

Merged
coderdan merged 2 commits intomainfrom
release-prep
May 2, 2026
Merged

chore: prepare 0.1.0 release for crates.io#9
coderdan merged 2 commits intomainfrom
release-prep

Conversation

@coderdan
Copy link
Copy Markdown
Collaborator

@coderdan coderdan commented May 2, 2026

Summary

Pre-publication tidy-up before pushing 0.1.0 to crates.io.

  • Update Cargo.toml description so it reflects both NEON and AVX2 (the original wording was written when only NEON encode existed); add homepage; add [package.metadata.docs.rs] so docs.rs renders both NeonEncoder and Avx2Encoder.
  • Mark `DecodeError` as `#[non_exhaustive]` so future variants aren't breaking. First publish is the cheap moment to do this.
  • Add `CHANGELOG.md` with an initial 0.1.0 entry (Keep-a-Changelog format).

Verification

  • `cargo fmt --check` clean
  • `cargo clippy --all-targets -- -D warnings` clean on stable + 1.85, on aarch64-apple-darwin and x86_64-apple-darwin
  • `cargo test` — 24 lib + 18 parity + 1 doctest, all green
  • `cargo package --list` — 18 files, xlsx/mise.toml/DS_Store correctly excluded
  • `cargo publish --dry-run` — 38 KiB compressed, no warnings
  • `RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --no-deps` clean

Test plan

  • CI green
  • Eyeball the rendered Cargo.toml description on crates.io after publish (post-merge)

coderdan added 2 commits May 2, 2026 19:35
- Update Cargo.toml description so it reflects both NEON and AVX2 paths
  (was "NEON encode on aarch64") and includes decode support; add
  `homepage` field; add `[package.metadata.docs.rs]` so docs.rs renders
  the per-arch entry points (NeonEncoder, Avx2Encoder) cleanly across
  both x86_64 and aarch64 builds.
- Mark `DecodeError` as `#[non_exhaustive]` so future error variants are
  not a breaking change. Doing this on the first publish is cheap; doing
  it later requires a major version bump.
- Add CHANGELOG.md with an initial 0.1.0 entry following Keep a Changelog
  conventions.

Verified `cargo package --list` and `cargo publish --dry-run`: 18 files,
38 KiB compressed, no warnings. The xlsx/mise.toml/DS_Store excludes are
working.
@coderdan coderdan merged commit 83e663f into main May 2, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant