[#77] Adjust release documentation

doc/how-to-create-an-iceoryx2-release.md

@@ -75,7 +75,17 @@ Assume that the new version number is `X.Y.Z`.
 9. **Merge all changes to `main`.**
 10. Set tag on GitHub and add the release document as notes to the tag
     description. Add also a link to the file.
-11. Call `$GIT_ROOT$/./internal/scripts/crates_io_publish_script.sh` and publish
+11. Check the order of all dependencies in
+    `$GIT_ROOT$/./internal/scripts/crates_io_publish_script.sh`.
+    When calling `cargo publish -p $PACKAGE$` all dependencies, also dev-dependencies,
+    must be already published to `crates.io` via `cargo publish -p`. Verify the
+    correct ordering of dependencies by checking the `[dependencies]` and
+    `[dev-dependencies]`
+    section in the `Cargo.toml` file of every crate in the workspace.
+    * If the publish script was started and a crate requires a dependency which
+      is not available on `crates.io` the release has to be redone and the patch
+      version has to increase by one for the whole workspace.
+12. Call `$GIT_ROOT$/./internal/scripts/crates_io_publish_script.sh` and publish
     all crates on `crates.io` and `docs.rs`.
-12. Verify that the release looks fine on `docs.rs` (click through the
+13. Verify that the release looks fine on `docs.rs` (click through the
     documentation to check if everything was generated correctly)

doc/release-notes/iceoryx2-v0.4.0.md

@@ -16,22 +16,22 @@
 * Nodes cleanup all resources of dead nodes on creation and destruction
   [#96](https://github.com/eclipse-iceoryx/iceoryx2/issues/96)
 * CLI for iox2 [#98](https://github.com/eclipse-iceoryx/iceoryx2/issues/98)
-  * Add `iox2` CLI
-  * Add `iox2-service` CLI
-  * Add `iox2-node` CLI
+    * Add `iox2` CLI
+    * Add `iox2-service` CLI
+    * Add `iox2-node` CLI
 * Introduce Nodes [#102](https://github.com/eclipse-iceoryx/iceoryx2/issues/102)
-  * Implement Serialize,Deserialize for
-    * `SemanticString`
-    * `UniqueSystemId`
+    * Implement Serialize,Deserialize for
+        * `SemanticString`
+        * `UniqueSystemId`
 * Nodes register in service to enable monitoring
   [#103](https://github.com/eclipse-iceoryx/iceoryx2/issues/103)
 * Multiple features from
   [#195](https://github.com/eclipse-iceoryx/iceoryx2/issues/195)
 
-  * Introduce `payload_alignment` in `publish_subscribe` builder to increase
+    * Introduce `payload_alignment` in `publish_subscribe` builder to increase
     alignment of payload for all service samples
-  * Introduce support for slice-types with dynamic sizes.
-  * Introduce `max_slice_len` in the publisher builder to set support dynamic
+    * Introduce support for slice-types with dynamic sizes.
+    * Introduce `max_slice_len` in the publisher builder to set support dynamic
     sized types (slices).
 
   ```rust
@@ -62,19 +62,19 @@
   ```
 
 * 32-bit support [#200](https://github.com/eclipse-iceoryx/iceoryx2/issues/200)
-  * Introduce `IoxAtomic` that supports up to 128bit atomics on 32-bit
+    * Introduce `IoxAtomic` that supports up to 128bit atomics on 32-bit
     architecture with a ReadWriteLock
-  * add CI targets to officially support 32-bit
+    * add CI targets to officially support 32-bit
 * Example that demonstrates publish-subscribe communication with dynamic data
   [#205](https://github.com/eclipse-iceoryx/iceoryx2/issues/205)
 * Introduce `PlacementNew` trait and derive proc-macro
   [#224](https://github.com/eclipse-iceoryx/iceoryx2/issues/224)
 * Custom service properties support, see
   [example](https://github.com/eclipse-iceoryx/iceoryx2/tree/main/examples/rust/service_properties)
   [#231](https://github.com/eclipse-iceoryx/iceoryx2/issues/231)
-  * Implement Serialize,Deserialize for
-    * `FixedSizeByteString`
-    * `FixedSizeVec`
+    * Implement Serialize,Deserialize for
+        * `FixedSizeByteString`
+        * `FixedSizeVec`
 * TryInto implemented for `{Node|Service}Name`
   [#243](https://github.com/eclipse-iceoryx/iceoryx2/issues/243)
 * Add custom user header