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

[#3] Trigger CI when a PR changes from draft to ready #542

Merged

Conversation

elBoberido
Copy link
Member

@elBoberido elBoberido commented Dec 4, 2024

Notes for Reviewer

The handling of draft PR is improved and the CI is fully skipped instead of resulting in a failure, which spams the github notifications.

Additionally, with this change, it is sufficient to set a PR to Ready for review in order to trigger the CI instead of having to do a dummy push.

Finally, the line breaks in bullet lists are also visible in the rendered markdown. Therefore the line limitation is suppressed for the PR template.

Prevent CI from running on each commit while the work is still in progress

  • Set the PR to a draft status, e.g. by the Convert to draft link, to indicate
    that the work is not yet ready for review
  • Once the PR is ready for review, press the Ready for Review button and push
    a final commit to trigger the CI

Pre-Review Checklist for the PR Author

  • Add sensible notes for the reviewer
  • PR title is short, expressive and meaningful
  • Relevant issues are linked in the References section
  • Every source code file has a copyright header with
    SPDX-License-Identifier: Apache-2.0 OR MIT
  • Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  • Commits messages are according to this guideline
  • Tests follow the best practice for testing
  • Changelog updated in the unreleased section including API
    breaking changes
  • Assign PR to reviewer
  • All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Unit tests have been written for new behavior
  • Public API is documented
  • PR title describes the changes

Post-review Checklist for the PR Author

  • All open points are addressed and tracked via issues

References

Relates to #3

elfenpiff
elfenpiff previously approved these changes Dec 4, 2024
@elBoberido elBoberido marked this pull request as draft December 4, 2024 13:44
@elBoberido elBoberido force-pushed the iox2-3-skip-CI-for-draft-pr branch from 6b35ccb to f160c19 Compare December 4, 2024 13:45
@elBoberido elBoberido marked this pull request as ready for review December 4, 2024 13:50
@elBoberido elBoberido force-pushed the iox2-3-skip-CI-for-draft-pr branch 2 times, most recently from f1252af to 893ea48 Compare December 4, 2024 14:01
@elBoberido elBoberido requested a review from elfenpiff December 4, 2024 14:01
@elBoberido elBoberido self-assigned this Dec 4, 2024
@elBoberido elBoberido force-pushed the iox2-3-skip-CI-for-draft-pr branch from 893ea48 to d6dfbf3 Compare December 4, 2024 14:06
Copy link

codecov bot commented Dec 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.13%. Comparing base (0ad8d53) to head (d6dfbf3).
Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #542   +/-   ##
=======================================
  Coverage   79.13%   79.13%           
=======================================
  Files         202      202           
  Lines       24887    24887           
=======================================
  Hits        19695    19695           
  Misses       5192     5192           

see 3 files with indirect coverage changes

@elBoberido elBoberido merged commit b1d41bb into eclipse-iceoryx:main Dec 4, 2024
46 of 47 checks passed
@elBoberido elBoberido deleted the iox2-3-skip-CI-for-draft-pr branch December 4, 2024 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants