sat-rs/satrs-mib/release-checklist.md
Robin Mueller ec9abea11a
Some checks failed
Rust/sat-rs/pipeline/head There was a failure building this commit
add release checklist
2023-08-28 23:31:32 +02:00

801 B

Checklist for new releases

Pre-Release

  1. Make sure any new modules are documented sufficiently enough and check docs with cargo doc --all-features --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 annotaged tag and push it with git tag -a satrs-mib-<version> and git push -u origin satrs-mib-<version>
  2. Create a new release on EGit based on the tag.