Merge pull request 'Prepare first satrs-core alpha release' (#67) from prep-satrs-core-alpha.0 into main

Reviewed-on: #67

satrs-core/Cargo.toml

@@ -61,16 +61,16 @@ default-features = false
 optional = true
 
 [dependencies.spacepackets]
-version = "0.7.0-beta.0"
+version = "0.7.0-beta.1"
 # path = "../../spacepackets"
-git = "https://egit.irs.uni-stuttgart.de/rust/spacepackets.git"
+# git = "https://egit.irs.uni-stuttgart.de/rust/spacepackets.git"
-rev = "00fdfde015040d0a349444136f6b41f3e44e3a15"
+# rev = ""
-# branch = "size-missmatch-struct-variant"
+# branch = ""
 default-features = false
 
 [dev-dependencies]
 serde = "1"
-zerocopy = ">0.5, <=0.7"
+zerocopy = "0.7"
 once_cell = "1.13"
 serde_json = "1"
 

satrs-core/release-checklist.md

@@ -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.

satrs-core/src/pool.rs

@@ -344,7 +344,7 @@ mod alloc_mod {
     }
 
     /// Pool implementation providing sub-pools with fixed size memory blocks. More details in
-    /// the [module documentation][super::pool]
+    /// the [module documentation][crate::pool]
     pub struct LocalPool {
         pool_cfg: PoolCfg,
         pool: Vec<Vec<u8>>,

satrs-core/src/tmtc/pus_distrib.rs

@@ -9,8 +9,9 @@
 //! [ReceivesTcCore] trait which allows to pass raw packets, CCSDS packets and PUS TC packets into
 //! it. Upon receiving a packet, it performs the following steps:
 //!
-//! 1. It tries to extract the [SpHeader] and [PusTc] objects from the raw bytestream. If this
+//! 1. It tries to extract the [SpHeader] and [spacepackets::ecss::tc::PusTcReader] objects from
-//!    process fails, a [PusDistribError::PusError] is returned to the user.
+//!    the raw bytestream. If this process fails, a [PusDistribError::PusError] is returned to the
+//!    user.
 //! 2. If it was possible to extract both components, the packet will be passed to the
 //!    [PusServiceProvider::handle_pus_tc_packet] method provided by the user.
 //!