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: Run phan with previous-version WP stubs too #36530

Merged
merged 7 commits into from
Mar 22, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Mar 22, 2024

Proposed changes:

Phan can help us detect accidental addition of calls to PHP functions, classes, and methods added to WordPress core since the supported previous versions if we supply it the right stub files.

Note for this to really work, though, we'll need to clean up the existing baselines, since if a file already has an undefined function being ignored by the baseline then a new undefined function use added in the same file would be ignored too.

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

pf4qpu-mj-p2

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

No

Testing instructions:

  • First version of this PR should flag this call, which can serve as a good test for it working.

Phan can help us detect accidental addition of calls to PHP functions,
classes, and methods added to WordPress core since the supported
previous versions if we supply it the right stub files.

Note for this to really work, though, we'll need to clean up the
existing baselines, since if a file already has an undefined function
being ignored by the baseline then a new undefined function use added in
the same file would be ignored too.
@anomiex anomiex added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Pri] Normal labels Mar 22, 2024
@anomiex anomiex requested review from kraftbj and a team March 22, 2024 14:02
@anomiex anomiex self-assigned this Mar 22, 2024
@github-actions github-actions bot added the Actions GitHub actions used to automate some of the work around releases and repository management label Mar 22, 2024
Copy link
Contributor

github-actions bot commented Mar 22, 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.


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for April 2, 2024 (scheduled code freeze on April 1, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Copy link
Contributor

github-actions bot commented Mar 22, 2024

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 WordPress.com Simple 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, and enable the add/ci-phan-run-with-wp-previous branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack add/ci-phan-run-with-wp-previous
    

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 [Feature] Google Fonts [Feature] SSO [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Mar 22, 2024
anomiex added 4 commits March 22, 2024 11:05
…s` is the only thing in the `if`."

No, I just did it wrong.

This reverts commit 3699cc0.
Any that weren't caught by the normal run are false positives.
Copy link
Contributor

@tbradsha tbradsha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once I realized I needed to review the first commit to see the caught error, all was well.

@kraftbj kraftbj mentioned this pull request Mar 22, 2024
3 tasks
@kraftbj kraftbj merged commit fb912fe into trunk Mar 22, 2024
56 checks passed
@kraftbj kraftbj deleted the add/ci-phan-run-with-wp-previous branch March 22, 2024 20:58
@github-actions github-actions bot added this to the jetpack/13.3 milestone Mar 22, 2024
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Mar 22, 2024
anomiex added a commit that referenced this pull request May 2, 2024
The test is taking longer now, probably since we added the run against
the previous WP version's stubs in #36530. Update the timeout for runs
at the edge of the curve.
@anomiex anomiex mentioned this pull request May 2, 2024
3 tasks
anomiex added a commit that referenced this pull request May 2, 2024
The test is taking longer now, probably since we added the run against
the previous WP version's stubs in #36530. Update the timeout for runs
at the edge of the curve.
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 [Feature] Google Fonts [Feature] SSO [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants