diff --git a/satrs-mib/release-checklist.md b/satrs-mib/release-checklist.md new file mode 100644 index 0000000..1cda6f9 --- /dev/null +++ b/satrs-mib/release-checklist.md @@ -0,0 +1,25 @@ +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-` and + `git push -u origin satrs-mib-` +2. Create a new release on `EGit` based on the tag. +