add release-checklist for satrs-core
Some checks are pending
Rust/sat-rs/pipeline/head Build started...
Some checks are pending
Rust/sat-rs/pipeline/head Build started...
This commit is contained in:
parent
a14f8be2ea
commit
de454cc372
22
satrs-core/release-checklist.md
Normal file
22
satrs-core/release-checklist.md
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
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 release on `EGit` based on the release branch.
|
Loading…
x
Reference in New Issue
Block a user