From 1726e34fa7cb371f4fc2e1bd8ddfd1ac669279ff Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 4 Nov 2024 11:16:25 +0100 Subject: [PATCH] satrs-shared v0.2.0 --- satrs-shared/CHANGELOG.md | 4 ++++ satrs-shared/Cargo.toml | 7 ++++--- satrs-shared/docs.sh | 3 +++ satrs-shared/release-checklist.md | 23 +++++++++++++++++++++++ satrs-shared/src/lib.rs | 2 +- satrs/Cargo.toml | 4 ++-- 6 files changed, 37 insertions(+), 6 deletions(-) create mode 100755 satrs-shared/docs.sh create mode 100644 satrs-shared/release-checklist.md diff --git a/satrs-shared/CHANGELOG.md b/satrs-shared/CHANGELOG.md index 8e718d8..15de892 100644 --- a/satrs-shared/CHANGELOG.md +++ b/satrs-shared/CHANGELOG.md @@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/). # [unreleased] +# [v0.2.0] 2024-11-04 + +Semver bump, due to added features in v0.1.4 + # [v0.1.4] 2024-04-24 ## Added diff --git a/satrs-shared/Cargo.toml b/satrs-shared/Cargo.toml index 175f909..67a3928 100644 --- a/satrs-shared/Cargo.toml +++ b/satrs-shared/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "satrs-shared" description = "Components shared by multiple sat-rs crates" -version = "0.1.4" +version = "0.2.0" edition = "2021" authors = ["Robin Mueller "] homepage = "https://absatsw.irs.uni-stuttgart.de/projects/sat-rs/" @@ -27,7 +27,8 @@ default-features = false [features] serde = ["dep:serde", "spacepackets/serde"] -spacepackets = ["dep:defmt", "spacepackets/defmt"] +defmt = ["dep:defmt", "spacepackets/defmt"] [package.metadata.docs.rs] -rustdoc-args = ["--cfg", "docs_rs", "--generate-link-to-definition"] +all-features = true +rustdoc-args = ["--generate-link-to-definition"] diff --git a/satrs-shared/docs.sh b/satrs-shared/docs.sh new file mode 100755 index 0000000..37563d2 --- /dev/null +++ b/satrs-shared/docs.sh @@ -0,0 +1,3 @@ +#!/bin/sh +export RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" +cargo +nightly doc --all-features --open diff --git a/satrs-shared/release-checklist.md b/satrs-shared/release-checklist.md new file mode 100644 index 0000000..c2f75e0 --- /dev/null +++ b/satrs-shared/release-checklist.md @@ -0,0 +1,23 @@ +Checklist for new releases +======= + +# Pre-Release + +1. Make sure any new modules are documented sufficiently enough and check docs by running + `docs.sh`. +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` and `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` with the name `satrs-`. + diff --git a/satrs-shared/src/lib.rs b/satrs-shared/src/lib.rs index 428f01f..4fdba60 100644 --- a/satrs-shared/src/lib.rs +++ b/satrs-shared/src/lib.rs @@ -1,4 +1,4 @@ //! This crates contains modules shared among other sat-rs framework crates. #![no_std] -#![cfg_attr(docs_rs, feature(doc_auto_cfg))] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] pub mod res_code; diff --git a/satrs/Cargo.toml b/satrs/Cargo.toml index ec2b2d0..94725f7 100644 --- a/satrs/Cargo.toml +++ b/satrs/Cargo.toml @@ -20,14 +20,14 @@ smallvec = "1" crc = "3" [dependencies.satrs-shared] -version = ">=0.1.3, <0.2" +version = ">=0.1.3, <=0.2" [dependencies.num_enum] version = ">0.5, <=0.7" default-features = false [dependencies.spacepackets] -version = "0.11" +version = "0.12" default-features = false [dependencies.cobs] -- 2.43.0