Skip to content

Conversation

mossmaurice
Copy link
Contributor

@mossmaurice mossmaurice commented Dec 27, 2024

Notes for Reviewer

  • Update MkDocs and documentation preparing for v3.0 release

    • Update version of MkDocs material related packages
    • Fix HTML footer
  • ToDo

    • Check all links => Proposal: only to be merged on release_3.0 branch
    • Run iceoryx_release.sh in
    • Review all exisiting articles
    • Go through items in Release validation for v3.0 #1295
    • Create release branch release_3.0 Not as part of this PR
    • Write release notes
    • Check ascinema recordings
    • Prepare ROS 2 release Not as part of this PR

Pre-Review Checklist for the PR Author

  1. Code follows the coding style of CONTRIBUTING.md
  2. Tests follow the best practice for testing
  3. Changelog updated in the unreleased section including API breaking changes
  4. Branch follows the naming format (iox-123-this-is-a-branch)
  5. Commits messages are according to this guideline
  6. Update the PR title
    • Follow the same conventions as for commit messages
    • Link to the relevant issue
  7. Relevant issues are linked
  8. Add sensible notes for the reviewer
  9. All checks have passed (except task-list-completed)
  10. Assign PR to reviewer

Checklist for the PR Reviewer

  • Consider a second reviewer for complex new features or larger refactorings
  • Commits are properly organized and messages are according to the guideline
  • Code according to our coding style and naming conventions
  • Unit tests have been written for new behavior
  • Public API changes are documented via doxygen
  • Copyright owner are updated in the changed files
  • All touched (C/C++) source code files from iceoryx_hoofs have been added to ./clang-tidy-diff-scans.txt
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

@mossmaurice mossmaurice added the documentation Improvements or additions to documentation label Dec 27, 2024
@mossmaurice mossmaurice self-assigned this Dec 27, 2024
Copy link

codecov bot commented Jan 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.67%. Comparing base (f33d582) to head (7e18fa4).
Report is 11 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2398      +/-   ##
==========================================
- Coverage   78.68%   78.67%   -0.02%     
==========================================
  Files         440      440              
  Lines       16986    16986              
  Branches     2361     2361              
==========================================
- Hits        13365    13363       -2     
- Misses       2740     2741       +1     
- Partials      881      882       +1     
Flag Coverage Δ
unittests 78.47% <ø> (-0.02%) ⬇️
unittests_timing 15.35% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

@mossmaurice mossmaurice force-pushed the iox-1295-release-validation-v3-0 branch from de9ce86 to 4c7e44f Compare January 27, 2025 11:11
@mossmaurice mossmaurice force-pushed the iox-1295-release-validation-v3-0 branch 2 times, most recently from d975517 to 8aa9f69 Compare January 28, 2025 11:07
@mossmaurice mossmaurice force-pushed the iox-1295-release-validation-v3-0 branch from 6e2bdbb to bbf7136 Compare January 30, 2025 13:50
@mossmaurice mossmaurice marked this pull request as ready for review January 30, 2025 13:50
@mossmaurice
Copy link
Contributor Author

@elBoberido Ready for review. The documentation is completely fixed. Please do the full review on this PR. Once the findings are addressed I'll merge only the commits without (DROP ME) to main and then create the release_3.0 branch. I'll open a separate PR with the (DROP ME) changes against release_3.0. Does that make sense to you?

@mossmaurice mossmaurice force-pushed the iox-1295-release-validation-v3-0 branch from bbf7136 to 2ed509b Compare February 17, 2025 15:31
@mossmaurice mossmaurice force-pushed the iox-1295-release-validation-v3-0 branch from 445e570 to d46678e Compare February 17, 2025 18:23
@mossmaurice
Copy link
Contributor Author

To go ahead and get this merged, I cut out the links for MkDocs which could be going to release_3.0 branch only. See #2418 (comment)

@mossmaurice
Copy link
Contributor Author

mossmaurice commented Feb 18, 2025

@budrus @elBoberido Thanks for the review 🙏 I addressed your findings. Back to you.

Copy link
Member

@elBoberido elBoberido left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you already revert the extraction of iceoryx-unreleased.md to iceoryx-v3-0-0-unreleased.md

@mossmaurice mossmaurice force-pushed the iox-1295-release-validation-v3-0 branch from 4ef68e3 to baf1547 Compare February 19, 2025 09:22
@mossmaurice mossmaurice merged commit 1a5b82d into eclipse-iceoryx:main Feb 19, 2025
23 checks passed
@mossmaurice mossmaurice deleted the iox-1295-release-validation-v3-0 branch February 19, 2025 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Release validation for v3.0

4 participants