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

ci: Avoid suggesting unnecessary baseline updates #37158

Merged
merged 1 commit into from
May 1, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented May 1, 2024

Proposed changes:

When checking for baselines that need updating due to fixed issues, we ignore the "issue statistics" comment at the top of the file so as to not make people have to update the baselines unnecessarily.

However, if one project has a real update needed while a different one has only comments, we're still instructing the author to update both of them even though only the former is needed.

Let's not do that.

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

Inspired by p1714573052936929-slack-CDLH4C1UZ

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

No

Testing instructions:

  • Make a PR based on this one that in one baseline file changes the actual arrays and in a different one only changes the issue statistics comments. The CI check should only tell you to run jetpack phan --update-baseline for the first, not the second.

When checking for baselines that need updating due to fixed issues, we
ignore the "issue statistics" comment at the top of the file so as to
not make people have to update the baselines unnecessarily.

However, if one project has a real update needed while a different one
has only comments, we're still instructing the author to update both of
them even though only the former is needed.

Let's not do that.
@anomiex anomiex added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Pri] Normal labels May 1, 2024
@anomiex anomiex requested a review from a team May 1, 2024 14:55
@anomiex anomiex self-assigned this May 1, 2024
@anomiex anomiex enabled auto-merge (squash) May 1, 2024 14:55
@github-actions github-actions bot added the Actions GitHub actions used to automate some of the work around releases and repository management label May 1, 2024
Copy link
Contributor

github-actions bot commented May 1, 2024

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 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.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

@anomiex anomiex merged commit 385d636 into trunk May 1, 2024
55 checks passed
@anomiex anomiex deleted the fix/ci-update-baselines branch May 1, 2024 16:52
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Actions GitHub actions used to automate some of the work around releases and repository management [Pri] Normal [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants