sat-rs/satrs/release-checklist.md
Robin Mueller 7c3879fbce
Some checks are pending
Rust/sat-rs/pipeline/pr-main Build queued...
last preparations
2024-02-12 17:11:59 +01:00

742 B

Checklist for new releases

Pre-Release

  1. Make sure any new modules are documented sufficiently enough and check docs with cargo +nightly doc --all-features --config 'rustdocflags=["--cfg", "doc_cfg"]' --open.
  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.
  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 with the name satrs-<version>.