satrs-shared v0.2.0

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

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 <[email protected]>"]
 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"]

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

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 with
+   `cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]' --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` 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-<version>`.
+

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;

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]