Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update MkDocs and documentation preparing for v3.0 release #2396

Closed

Conversation

mossmaurice
Copy link
Contributor

@mossmaurice mossmaurice commented Dec 23, 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
    • Run iceoryx_release.sh
    • Go through items in Release validation for v3.0 #1295
    • Create release branch release_3.0 (Before fixing the relative links?)
    • Write release notes
    • Prepare ROS 2 release

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 23, 2024
@mossmaurice mossmaurice self-assigned this Dec 23, 2024
@mossmaurice mossmaurice force-pushed the release-validation-v3-0 branch from 80fe48a to e7fe008 Compare December 23, 2024 17:31
Copy link

codecov bot commented Dec 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.71%. Comparing base (e088257) to head (e7fe008).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2396      +/-   ##
==========================================
+ Coverage   78.69%   78.71%   +0.01%     
==========================================
  Files         440      440              
  Lines       16981    16981              
  Branches     2361     2361              
==========================================
+ Hits        13364    13366       +2     
  Misses       2736     2736              
+ Partials      881      879       -2     
Flag Coverage Δ
unittests 78.51% <ø> (+0.01%) ⬆️
unittests_timing 15.36% <ø> (+<0.01%) ⬆️

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

see 2 files with indirect coverage changes

@mossmaurice mossmaurice deleted the release-validation-v3-0 branch December 27, 2024 13:18
@mossmaurice
Copy link
Contributor Author

Replaced by #2398

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
1 participant