Skip to content

Latest commit

 

History

History
14 lines (12 loc) · 1.11 KB

RELEASE.md

File metadata and controls

14 lines (12 loc) · 1.11 KB
Raw

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 contain all the necessary information about the new version.
  • Ensure that GitHub Actions CI is passing and MSRV is not changed, if changed update badge in README.md, CHANGELOG.md and Cargo.toml.
  • Define a new version according to Semantic Versioning and update it inside the following files:
    • Tag version in README.md installation instructions.
    • version property in Cargo.toml to the new version.
    • Rename Unreleased section in CHANGELOG.md to the new version and date.
  • Rebuild Cargo.lock by running cargo build.
  • Commit changes with message v<version>.
  • Run cargo publish to publish the crate to crates.io.