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

Release validation link fixes #2418

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

mossmaurice
Copy link
Contributor

Notes for Reviewer

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

  • Closes TBD

Copy link

codecov bot commented Feb 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.69%. Comparing base (1a5b82d) to head (48a11ce).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2418   +/-   ##
=======================================
  Coverage   78.69%   78.69%           
=======================================
  Files         440      440           
  Lines       16986    16986           
  Branches     2361     2361           
=======================================
  Hits        13367    13367           
  Misses       2740     2740           
  Partials      879      879           
Flag Coverage Δ
unittests 78.49% <ø> (ø)
unittests_timing 15.35% <ø> (ø)

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

see 2 files with indirect coverage changes

@mossmaurice
Copy link
Contributor Author

These are the minimal changes to make MkDocs build for https://iceoryx.io work. If there is time we can work on a solution that automates these changes and also includes a MkDocs CI job (see #1201).

@mossmaurice mossmaurice added the documentation Improvements or additions to documentation label Feb 17, 2025
@mossmaurice mossmaurice changed the base branch from iox-1295-release-validation-v3-0 to main February 19, 2025 14:50
@mossmaurice mossmaurice force-pushed the iox-1295-release-validation-link-fixes branch from e6c4fd3 to 48a11ce Compare February 19, 2025 14:51
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.

1 participant