-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #78 from elfenpiff/iox2-77-release-0.2.0-preparations
[#77] Release 0.2.0
- Loading branch information
Showing
7 changed files
with
117 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| Hi Rustaceans, | ||
|
|
||
| I'm excited to announce the release of iceoryx2, a new inter-process zero-copy | ||
| framework and middleware written entirely in Rust. | ||
|
|
||
| This Rust implementation succeeds the C++ project iceoryx, offering a | ||
| significant speed increase and improved latency. Rest assured, iceoryx, the | ||
| framework you've come to rely on, remains an active player in the field. It | ||
| continues to receive consistent enhancements and is regularly updated with new | ||
| features. However, the future is looking mighty Rust-y with iceoryx2. | ||
|
|
||
| In its initial version, iceoryx2 supports publish-subscribe messaging and | ||
| efficient event transmission between processes. Notably, there's no longer a | ||
| reliance on a central broker, simplifying the setup process. | ||
|
|
||
| For those interested, our GitHub repository contains the roadmap. I welcome | ||
| your feedback, whether it's about missing features or your top two or three | ||
| desired functionalities. | ||
|
|
||
| Our current areas of focus include Mac OS platform support, a C binding, the | ||
| waitset, a reactor event-multiplexing abstraction, and the expansion of | ||
| messaging patterns with features like request-response and pipelines. | ||
|
|
||
| Additionally, for those acquainted with our demonstrator robot Larry, | ||
| anticipate a Rusty transformation as he eagerly ventures into the realm of | ||
| Rust. | ||
|
|
||
| The iceoryx developers invite you to explore the GitHub repository, engage in | ||
| discussions, and contribute to the development of iceoryx2. | ||
|
|
||
| Elfenpiff | ||
|
|
||
| Links: | ||
|
|
||
| * repo: https://github.com/eclipse-iceoryx/iceoryx2 | ||
| * roadmap: https://github.com/eclipse-iceoryx/iceoryx2/blob/main/ROADMAP.md | ||
| * crates.io: https://crates.io/crates/iceoryx2 | ||
| * docs.rs: https://docs.rs/iceoryx2/0.1.0/iceoryx2/ |
Empty file.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # How To Create An iceoryx2 Release | ||
|
|
||
| Assume that the new version number is `X.Y.Z`. | ||
|
|
||
| 1. 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 | ||
| `$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 | ||
| `$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`. | ||
| * 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`.** | ||
|
|
||
| 8. Change `workspace.package.version` in `$GIT_ROOT$/Cargo.toml` to the new | ||
| version number `X.Y.Z`. | ||
| 9. 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` | ||
| (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: | ||
| * https://www.reddit.com/r/rust/ | ||
| * https://www.linkedin.com/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # iceoryx2 v0.2.0 | ||
|
|
||
| ## [v0.2.0](https://github.com/eclipse-iceoryx/iceoryx2/tree/v0.2.0) | ||
|
|
||
| [Full Changelog](https://github.com/eclipse-iceoryx/iceoryx2/compare/v0.1.1...v0.2.0) | ||
|
|
||
| ### Features | ||
|
|
||
| * MacOS Platform support [#51](https://github.com/eclipse-iceoryx/iceoryx2/issues/51) | ||
| * Services with the same name for different messaging patterns are supported [#16](https://github.com/eclipse-iceoryx/iceoryx2/issues/16) | ||
|
|
||
| ### Bugfixes | ||
|
|
||
| * Fix undefined behavior in `FixedSizeByteString::new_unchecked` [#61](https://github.com/eclipse-iceoryx/iceoryx2/issues/61) | ||
| * Fix suffix of static config [#66](https://github.com/eclipse-iceoryx/iceoryx2/issues/66) | ||
| * Interpret non-existing service directory as no existing services [#63](https://github.com/eclipse-iceoryx/iceoryx2/issues/63) | ||
|
|
||
| ### Refactoring | ||
|
|
||
| * Rename char in platform to c_char [#54](https://github.com/eclipse-iceoryx/iceoryx2/issues/54) | ||
| * Set reasonable rust min version to 1.70 and verify it with additional CI targets [#72](https://github.com/eclipse-iceoryx/iceoryx2/issues/72) | ||
|
|
||
| ### Workflow | ||
|
|
||
| * add `cargo audit` for security vulnerability checking in dependencies [#48](https://github.com/eclipse-iceoryx/iceoryx2/issues/48) | ||
|
|
||
| ### New API features | ||
|
|
||
| * Add `FixedSizeByteString::from_bytes_truncated` [#56](https://github.com/eclipse-iceoryx/iceoryx2/issues/56) | ||
| * Add `Deref`, `DerefMut`, `Clone`, `Eq`, `PartialEq` and `extend_from_slice` to (FixedSize)Vec [#58](https://github.com/eclipse-iceoryx/iceoryx2/issues/58) | ||
| * `MessagingPattern` implements `Display` [#64](https://github.com/eclipse-iceoryx/iceoryx2/issues/64) | ||
|
|
||
| ## Thanks To All Contributors Of This Version | ||
|
|
||
| * [Christian »elfenpiff« Eltzschig](https://github.com/elfenpiff) | ||
| * [Mathias »elBoberido« Kraus](https://github.com/elboberido) | ||
| * [»Shock-1«](https://github.com/Shock-1) | ||
| * [»hydroid7«](https://github.com/hydroid7) |