jetpack icon indicating copy to clipboard operation
jetpack copied to clipboard
verified publisher icon Automattic

Classic Theme Helper: featured content usage from module to package

Open darssen opened this issue 1 year ago • 2 comments

Proposed changes:

  • Updated Classic Theme Helper to use namespace and changed the main class of the package to be the Loader one.
  • Use the Classic Theme Helper package instead of the Theme Tools module
  • Deprecate existing class and functions in the Theme Tools Module
  • Removes wpcom specific functions TODO: Needs wpcom diff to move them to the mu-plugin loading the feature on simple.

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

pfwV0U-6Y-p2

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

Testing instructions:

TBD

darssen avatar May 07 '24 11:05 darssen

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 update/move-featured-content-usage-from-module-to-package branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

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

    bin/jetpack-downloader test jetpack update/move-featured-content-usage-from-module-to-package

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/move-featured-content-usage-from-module-to-package

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[bot] avatar May 07 '24 11:05 github-actions[bot]

Thank you for your PR!

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

  • :white_check_mark: Include a description of your PR changes.
  • :white_check_mark: Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • :white_check_mark: Add testing instructions.
  • :white_check_mark: Specify whether this PR includes any changes to data or privacy.
  • :white_check_mark: 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 :robot:

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 July 2, 2024 (scheduled code freeze on July 1, 2024).

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

Mu Wpcom plugin:

  • Next scheduled release: July 2, 2024.
  • Scheduled code freeze: June 24, 2024.

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

Classic Theme helper plugin plugin:

  • Next scheduled release: July 2, 2024.
  • Scheduled code freeze: June 24, 2024.

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

github-actions[bot] avatar May 07 '24 11:05 github-actions[bot]

Tests well across self-hosted, Atomic, Simple.

In modules/theme-tools/featured-content.php, I believe the three static variables can be removed too ( $max_posts, $post_types, $tag), as they're all removed from the function contents now (only used in the package version).

coder-karen avatar Jun 05 '24 13:06 coder-karen

Tests well across self-hosted, Atomic, Simple.

In modules/theme-tools/featured-content.php, I believe the three static variables can be removed too ( $max_posts, $post_types, $tag), as they're all removed from the function contents now (only used in the package version).

Thanks for reviewing @coder-karen !

Since these are already public, I think we should keep them in case some existing code is using them directly. Not sure though how to handle deprecation notices in that case, since I haven't found any function to deprecate properties.

It is an edge case and I assume that the deprecation notices for the rest of the functions in the class, if used directly, should be enough. Nonetheless, I have added the deprecated annotation to the properties in https://github.com/Automattic/jetpack/pull/37260/commits/3c7dcc69640c4168528bfad08a62366325b4841d.

darssen avatar Jun 07 '24 09:06 darssen