Skip to content

RELEASE.md

Latest commit

 

History

History
17 lines (15 loc) · 1.48 KB

RELEASE.md

File metadata and controls

17 lines (15 loc) · 1.48 KB

Release checklist

This document is a checklist for the release process of the logged-stream project.

  • Ensure that the CHANGELOG.md contains all unreleased changes and adheres to the Keep a Changelog format.
  • Ensure that the README.md contains all the necessary information about the new version.
  • Ensure that the CONTRIBUTING.md is up to date with any new contribution guidelines or processes.
  • Ensure that GitHub Actions checks are passing. If the MSRV has changed, update the badge in README.md, add a note to CHANGELOG.md, and update the rust-version property in Cargo.toml.
  • Define a new version according to Semantic Versioning and update it inside the following files:
    • Update the version property in Cargo.toml to the new version.
    • Rename the Unreleased section in CHANGELOG.md to the new version and current date.
    • Update the tag version in the installation section of README.md to the new version.
  • Rebuild Cargo.lock by running cargo build.
  • Commit changes with message v<version>.
  • Run cargo publish to publish the crate to crates.io.
  • Push changes to the repository.
  • Draft a new release in the repository's "Releases" section on GitHub. Include the new version and the changelog highlights in the release description.