Merge pull request #94 from elfenpiff/iox2-77-0.2.2-release

[#77] Set release version to 0.2.2

Cargo.toml

@@ -33,26 +33,26 @@ license = "MIT OR Apache-2.0"
 readme = "README.md"
 repository = "https://github.com/eclipse-iceoryx/iceoryx2"
 rust-version = "1.70"
-version = "0.2.1"
+version = "0.2.2"
 
 [workspace.dependencies]
-iceoryx2-bb-threadsafe = { version = "0.2.1", path = "iceoryx2-bb/threadsafe/" }
-iceoryx2-bb-lock-free = { version = "0.2.1", path = "iceoryx2-bb/lock-free/" }
-iceoryx2-bb-container = { version = "0.2.1", path = "iceoryx2-bb/container/" }
-iceoryx2-bb-elementary = { version = "0.2.1", path = "iceoryx2-bb/elementary/" }
-iceoryx2-bb-log = { version = "0.2.1", path = "iceoryx2-bb/log/" }
-iceoryx2-bb-memory = { version = "0.2.1", path = "iceoryx2-bb/memory/" }
-iceoryx2-bb-posix = { version = "0.2.1", path = "iceoryx2-bb/posix/" }
-iceoryx2-bb-system-types = { version = "0.2.1", path = "iceoryx2-bb/system-types/" }
-iceoryx2-bb-testing = { version = "0.2.1", path = "iceoryx2-bb/testing/" }
+iceoryx2-bb-threadsafe = { version = "0.2.2", path = "iceoryx2-bb/threadsafe/" }
+iceoryx2-bb-lock-free = { version = "0.2.2", path = "iceoryx2-bb/lock-free/" }
+iceoryx2-bb-container = { version = "0.2.2", path = "iceoryx2-bb/container/" }
+iceoryx2-bb-elementary = { version = "0.2.2", path = "iceoryx2-bb/elementary/" }
+iceoryx2-bb-log = { version = "0.2.2", path = "iceoryx2-bb/log/" }
+iceoryx2-bb-memory = { version = "0.2.2", path = "iceoryx2-bb/memory/" }
+iceoryx2-bb-posix = { version = "0.2.2", path = "iceoryx2-bb/posix/" }
+iceoryx2-bb-system-types = { version = "0.2.2", path = "iceoryx2-bb/system-types/" }
+iceoryx2-bb-testing = { version = "0.2.2", path = "iceoryx2-bb/testing/" }
 
-iceoryx2-pal-concurrency-sync = { version = "0.2.1", path = "iceoryx2-pal/concurrency-sync/" }
-iceoryx2-pal-posix = { version = "0.2.1", path = "iceoryx2-pal/posix/" }
-iceoryx2-pal-configuration = { version = "0.2.1", path = "iceoryx2-pal/configuration/" }
+iceoryx2-pal-concurrency-sync = { version = "0.2.2", path = "iceoryx2-pal/concurrency-sync/" }
+iceoryx2-pal-posix = { version = "0.2.2", path = "iceoryx2-pal/posix/" }
+iceoryx2-pal-configuration = { version = "0.2.2", path = "iceoryx2-pal/configuration/" }
 
-iceoryx2-cal = { version = "0.2.1", path = "iceoryx2-cal" }
+iceoryx2-cal = { version = "0.2.2", path = "iceoryx2-cal" }
 
-iceoryx2 = { version = "0.2.1", path = "iceoryx2/" }
+iceoryx2 = { version = "0.2.2", path = "iceoryx2/" }
 
 bindgen = { version = "0.65.1" }
 bitflags = { version = "1.3.2" }

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

@@ -2,36 +2,35 @@
 
 Assume that the new version number is `X.Y.Z`.
 
- 1. Copy `$GIT_ROOT$/doc/release-notes/iceoryx2-unreleased.md` to
+ 1. Use generic release issue ([#77]) and create a new branch `iox2-77-X.Y.Z-release`
+ 2. Copy `$GIT_ROOT$/doc/release-notes/iceoryx2-unreleased.md` to
     `$GIT_ROOT$/doc/release-notes/iceoryx2-vX.Y.Z.md`.
- 2. Fill out all version place holders/old version numbers in newly created
+ 3. Fill out all version place holders/old version numbers in newly created
     `$GIT_ROOT$/doc/release-notes/iceoryx2-vX.Y.Z.md`, remove template example
     entries and clean up.
- 3. Add the section `Thanks To All Contributors Of This Version` in
+ 4. Add the section `Thanks To All Contributors Of This Version` in
     `$GIT_ROOT$/doc/release-notes/iceoryx2-vX.Y.Z.md` and list all contributors
     of the new release.
- 4. Add new long-term contributors to the `$GIT_ROOT$/README.md`.
+ 5. Add new long-term contributors to the `$GIT_ROOT$/README.md`.
     * Shall have provided multiple PRs and reviews/issues.
- 5. Remove all entries from
-    `$GIT_ROOT$/doc/release-notes/iceoryx2-unreleased.md` and bring it in the
-    empty state again. Fill it with example entries.
- 6. Create `$GIT_ROOT$/doc/announcements/iceoryx2-vX.Y.Z.md` and fill it with
-    all the different announcement texts.
- 7. **Merge all changes to `main`.**
-
+ 6. Override
+    `$GIT_ROOT$/doc/release-notes/iceoryx2-unreleased.md` with
+    `$GIT_ROOT$/doc/release-notes/iceoryx2-release-template.md`
+    and bring it in the empty state again.
+ 7. (Major release only) Create `$GIT_ROOT$/doc/announcements/iceoryx2-vX.Y.Z.md`
+    and fill it with all the different announcement texts.
  8. Change `workspace.package.version` in `$GIT_ROOT$/Cargo.toml` to the new
     version number `X.Y.Z`.
     * **IMPORTANT** change version to `X.Y.Z` for all `iceoryx2-**` packages under
       `[workspace.dependencies]`
- 9. Call `$GIT_ROOT$/./internal/scripts/crates_io_publish_script.sh` and publish
+ 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
     all crates on `crates.io` and `docs.rs`.
- 10. Verify that the release looks fine on `docs.rs`
+ 12. Verify that the release looks fine on `docs.rs`
     (click through the documentation to check if everything was generated
     correctly)
- 11. **Merge all changes to `main`.**
-
- 12. Set tag on GitHub and add the release document as notes to the tag
-    description. Add also a link to the file.
- 13. Announce new release on:
+ 13. (Major release only) Announce new release on:
     * https://www.reddit.com/r/rust/
     * https://www.linkedin.com/

doc/release-notes/iceoryx2-release-template.md

@@ -0,0 +1,47 @@
+# iceoryx2 v?.?.?
+
+## [vx.x.x](https://github.com/eclipse-iceoryx/iceoryx2/tree/vx.x.x)
+
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx2/compare/vx.x.x...vx.x.x)
+
+### Features
+
+ <!-- NOTE: Add new entries sorted by issue number to minimize the possibility of conflicts when merging. -->
+
+ * Example text [#1](https://github.com/eclipse-iceoryx/iceoryx2/issues/1)
+
+### Bugfixes
+
+ <!-- NOTE: Add new entries sorted by issue number to minimize the possibility of conflicts when merging. -->
+
+ * Example text [#1](https://github.com/eclipse-iceoryx/iceoryx2/issues/1)
+
+### Refactoring
+
+ <!-- NOTE: Add new entries sorted by issue number to minimize the possibility of conflicts when merging. -->
+
+ * Example text [#1](https://github.com/eclipse-iceoryx/iceoryx2/issues/1)
+
+### Workflow
+
+ <!-- NOTE: Add new entries sorted by issue number to minimize the possibility of conflicts when merging. -->
+
+ * Example text [#1](https://github.com/eclipse-iceoryx/iceoryx2/issues/1)
+
+### New API features
+
+ <!-- NOTE: Add new entries sorted by issue number to minimize the possibility of conflicts when merging. -->
+
+ * Example text [#1](https://github.com/eclipse-iceoryx/iceoryx2/issues/1)
+
+### API Breaking Changes
+
+1. Example
+
+    ```rust
+    // old
+    let fuu = hello().is_it_me_you_re_looking_for()
+
+    // new
+    let fuu = hypnotoad().all_glory_to_the_hypnotoad()
+    ```

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

@@ -1,8 +1,8 @@
-# iceoryx2 v0.2.0
+# iceoryx2 v0.2.1
 
-## [v0.2.0](https://github.com/eclipse-iceoryx/iceoryx2/tree/v0.2.0)
+## [v0.2.1](https://github.com/eclipse-iceoryx/iceoryx2/tree/v0.2.1)
 
-[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx2/compare/v0.1.1...v0.2.0)
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx2/compare/v0.1.1...v0.2.1)
 
 ### Features
 

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

@@ -0,0 +1,20 @@
+# iceoryx2 v0.2.2
+
+## [v0.2.2](https://github.com/eclipse-iceoryx/iceoryx2/tree/v0.2.2)
+
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx2/compare/v0.2.1...v0.2.2)
+
+### Bugfixes
+
+ * Fix `clock_nanosleep` on macOS [#80](https://github.com/eclipse-iceoryx/iceoryx2/issues/80)
+ * Fix broken `sighandler_t` translation [#81](https://github.com/eclipse-iceoryx/iceoryx2/issues/81)
+
+### Refactoring
+
+ * Use only one config file for every platform [#15](https://github.com/eclipse-iceoryx/iceoryx2/issues/15)
+
+## Thanks To All Contributors Of This Version
+
+ * [Christian »elfenpiff« Eltzschig](https://github.com/elfenpiff)
+ * [Mathias »elBoberido« Kraus](https://github.com/elboberido)
+