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

required-review: Add is-author-or-reviewer condition #41966

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Feb 21, 2025

Proposed changes:

Sometimes people want to allow someone (or some team) to "self-review" code. GitHub doesn't support self-reviews directly, but we can assume that the author has reviewed their own PR in the writing of it.

Also, this is well past needing some automated testing. Add some for the file being touched here.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Fixes #41933

Does this pull request change what data or activity we track or use?

No

Testing instructions:

  • CI happy? Tests look like the cover everything?

Sometimes people want to allow someone (or some team) to "self-review"
code. GitHub doesn't support self-reviews directly, but we can assume
that the author has reviewed their own PR in the writing of it.

Also, this is well past needing some automated testing. Add some for the
file being touched here.

Fixes #41933
@anomiex anomiex added [Status] Needs Review A Jetpack Crew expert's review is needed. Typically for significant changes to core functionality. [Type] Feature Request [Pri] Normal labels Feb 21, 2025
@anomiex anomiex requested a review from a team February 21, 2025 21:03
@anomiex anomiex self-assigned this Feb 21, 2025
Copy link
Contributor

github-actions bot commented Feb 21, 2025

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack or WordPress.com Site Helper), and enable the add/required-review-is-author-check branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack add/required-review-is-author-check
bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/required-review-is-author-check

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added [Action] Required Review [Tests] Includes Tests Actions GitHub actions used to automate some of the work around releases and repository management Docs labels Feb 21, 2025
Copy link
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Copy link

Code Coverage Summary

7 files are newly checked for coverage. Only the first 5 are listed here.

File Coverage
projects/github-actions/required-review/src/main.js 0/67 (0.00%) 💔
projects/github-actions/required-review/src/paths.js 0/17 (0.00%) 💔
projects/github-actions/required-review/src/reporter.js 0/16 (0.00%) 💔
projects/github-actions/required-review/src/request-review.js 0/23 (0.00%) 💔
projects/github-actions/required-review/src/reviewers.js 0/18 (0.00%) 💔

Full summary · PHP report · JS report

Add label I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. to override the failing coverage check.

@anomiex
Copy link
Contributor Author

anomiex commented Feb 21, 2025

Too bad it only does five, it missed out on having this line 😀

File Coverage
projects/github-actions/required-review/src/requirement.js 110/110 (100.00%) 💚

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Action] Required Review Actions GitHub actions used to automate some of the work around releases and repository management Docs [Pri] Normal [Status] Needs Review A Jetpack Crew expert's review is needed. Typically for significant changes to core functionality. [Tests] Includes Tests [Type] Feature Request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug in action-required-review
1 participant