Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1 KB

release-checklist.md

File metadata and controls

25 lines (19 loc) · 1 KB
Raw

Checklist for new releases

Pre-Release

  1. Make sure any new modules are documented sufficiently enough and check docs with RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" cargo +nightly doc --all-features --open or cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docsrs" --generate-link-to-definition"]' --open (was problematic on more recent nightly versions).
  2. Bump version specifier in Cargo.toml.
  3. Update CHANGELOG.md: Convert unreleased section into version section with date and add new unreleased section.
  4. Run cargo test --all-features or cargo nextest r --all-features together with cargo test --doc.
  5. Run cargo fmt and cargo clippy. Check cargo msrv against MSRV in Cargo.toml.
  6. Wait for CI/CD results for EGit and Github. These also check cross-compilation for bare-metal targets.

Release

  1. cargo publish

Post-Release

  1. Create a new release on EGit based on the release branch.