Skip to content

v0.0.6 - Improve README accuracy and links (#54)

Latest
Latest

Choose a tag to compare

View all tags
@github-actions github-actions released this 10 Jun 23:37
· 71 commits to main since this release
v0.0.6
83fd8c4
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

🌟 Summary

🛠️ v0.0.6 is a maintenance-focused release that improves release accuracy, CI security, and package quality, with the latest PR from @glenn-jocher making the README clearer so users install the correct crate version.

📊 Key Changes

  • 📘 README accuracy improved

    • The latest PR by @glenn-jocher updates the dependency example to point to the latest published crate version instead of an outdated one.
    • Existing badges, links, and community references were preserved.
    • This helps users copy the right install example from the start.

  • 📦 Crate version bumped to 0.0.6

    • The package version was updated from 0.0.5 to 0.0.6.

  • 🔒 CI and release workflows were hardened

    • GitHub Actions were upgraded and pinned to exact commit SHAs instead of floating tags.
    • This affects checkout, caching, Python setup, coverage upload, publishing, and SBOM generation.
    • Key workflow tools were updated, including:
      • actions/checkout
      • codecov/codecov-action
      • Swatinem/rust-cache
      • astral-sh/setup-uv
      • anchore/sbom-action
      • taiki-e/install-action

  • 🧪 Coverage and benchmarking tooling updated

    • criterion was upgraded from 0.5 to 0.8.
    • Benchmark code was slightly modernized to use std::hint::black_box.

  • 🧾 Package metadata was expanded

    • Added explicit authors
    • Cleaned up Rust package settings
    • Added an include list so published crate contents are more controlled and predictable

  • 🛡️ New project quality configs added

    • Added clippy.toml for stricter linting guidance
    • Added deny.toml for dependency, license, and source checks

  • 🔗 Documentation links were cleaned up

    • Fixed redirected or outdated links, including the AGPL license URL and YouTube link formatting.

🎯 Purpose & Impact

  • ✅ Less confusion for new users

    • The README now better reflects the published crate version, so users are less likely to install an outdated dependency.

  • 🔐 More secure and reproducible automation

    • Pinning GitHub Actions to exact versions reduces supply-chain risk and makes CI behavior more consistent over time.

  • 🚀 Better release and publishing hygiene

    • Improved metadata and controlled package contents help make releases cleaner and more professional.

  • 🧹 Higher project quality with little user-facing disruption

    • This release does not introduce major new features or model changes, but it strengthens the template’s reliability, maintainability, and trustworthiness.

  • 👩‍💻 Better for maintainers and contributors

    • Updated linting, dependency checks, and CI tooling make development smoother and help catch issues earlier.

In short: v0.0.6 is a polish-and-stability release ✨—small on visible features, but important for making the Rust template easier to use, safer to maintain, and more accurate for everyone.

What's Changed

New Contributors

Full Changelog: v0.0.5...v0.0.6

Contributors

onuralpszr, glenn-jocher, and 2 other contributors
Assets 3
Loading