eclipse-iceoryx / iceoryx2

Eclipse iceoryx2™ - true zero-copy inter-process-communication in pure Rust
https://iceoryx.io
Apache License 2.0
1.03k stars 40 forks source link

[#98] add CLI tools to crates.io publish script #379

Closed orecham closed 2 months ago

orecham commented 2 months ago

Notes for Reviewer

  1. put all CLI tools in a single easy-to-install crate iceoryx2-cli
  2. add a README.md for the CLI crate
  3. add a markdownlint configuration to the project
    1. note that not all markdown files have been formatted, left for a separate PR
    2. at the very least it will ensure future markdown files are consistent
    3. rules can be adapted as we go
  4. rename CLI tools
    1. iox2-services -> iox2-service
    2. iox2-nodes -> iox2-node
  5. add the crate with CLI tools to script for publishing to crates.io
  6. remove cargo crates of unimplemented CLI tools
    1. iox2-introspect
    2. iox2-processes
    3. iox2-pub
    4. iox2-sub
    5. iox2-rpc
  7. update release notes with the tools that are implemented

Pre-Review Checklist for the PR Author

  1. [x] Add sensible notes for the reviewer
  2. [x] PR title is short, expressive and meaningful
  3. [x] Relevant issues are linked in the References section
  4. [ ] Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
  5. [x] Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  6. [x] Commits messages are according to this guideline
    • [x] Commit messages have the issue ID ([#123] Add posix ipc example)
    • [x] Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  7. [ ] Tests follow the best practice for testing
  8. [ ] Changelog updated in the unreleased section including API breaking changes
  9. [x] Assign PR to reviewer
  10. [ ] All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

Post-review Checklist for the PR Author

  1. [ ] All open points are addressed and tracked via issues

References

Relates #98

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 79.47%. Comparing base (0d14d50) to head (fdb27fe). Report is 8 commits behind head on main.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/379/graphs/tree.svg?width=650&height=150&src=pr&token=FN3YFXTJCI&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx)](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/379?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx) ```diff @@ Coverage Diff @@ ## main #379 +/- ## ========================================== - Coverage 79.48% 79.47% -0.01% ========================================== Files 193 193 Lines 22716 22716 ========================================== - Hits 18055 18054 -1 - Misses 4661 4662 +1 ``` [see 6 files with indirect coverage changes](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/379/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx)