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

Classic Theme Helper: Copy Content Options code to Classic Theme Helper package #39028

Merged
merged 12 commits into from
Aug 28, 2024

Conversation

coder-karen
Copy link
Contributor

@coder-karen coder-karen commented Aug 22, 2024

Fixes https://github.com/Automattic/vulcan/issues/465

Proposed changes:

  • Moved the main file content-options.php and the content-options folder containing PHP and JS files.
  • Added some Phan suppressions and attempted some Phan suggested fixes, but these won't be tested until requiring this feature via the package (in the next PR)
  • When requiring the feature (in the next PR), I'll aim to remove jQuery from customizer.js as well (but not in this copy PR).

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

https://github.com/Automattic/vulcan/issues/465

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

No.

Testing instructions:

  • The package code isn't being used yet, and no build is happening, so not much can be tested here other than checking that code updates make sense.
  • If you want to test out existing functionality, select a theme that includes Content Options such as Dara.
  • In the customizer, select 'Content Options'. Experiment with changing blog display, and all other settings (you may need t add featured images / categories to some posts to be able to test everything).

@coder-karen coder-karen self-assigned this Aug 22, 2024
@github-actions github-actions bot added [Feature] Theme Tools [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Aug 22, 2024
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 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!


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 September 3, 2024 (scheduled code freeze on September 2, 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 Aug 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/content-options-to-classic-theme-helper-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 add/content-options-to-classic-theme-helper-package
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/content-options-to-classic-theme-helper-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

@coder-karen coder-karen marked this pull request as ready for review August 22, 2024 15:32
$author = ( ! empty( $post_details['author'] ) ) ? $post_details['author'] : null;
$comment = ( ! empty( $post_details['comment'] ) ) ? $post_details['comment'] : null;

wp_enqueue_script( 'jetpack-content-options-customizer', plugins_url( 'customizer.js', __FILE__ ), array( 'jquery', 'customize-preview' ), '1.0', true );
Copy link
Contributor Author

@coder-karen coder-karen Aug 22, 2024

Choose a reason for hiding this comment

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

It would be worth looking into whether the Assets package can be used here for any scripts, where possible. Particularly as Webpack is compiling a minified version of customizer.js as well (in the dist folder). I'll look into that when requiring the feature via the package so it can be tested.
Also possibly relevant for post-details.php as well.

sergeymitr
sergeymitr previously approved these changes Aug 27, 2024
Copy link
Contributor

@sergeymitr sergeymitr left a comment

Choose a reason for hiding this comment

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

Tested with the Data theme, works as expected 👍

@sergeymitr sergeymitr added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Team Review labels Aug 27, 2024
Copy link
Contributor

@darssen darssen left a comment

Choose a reason for hiding this comment

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

Changes make sense.

@coder-karen coder-karen merged commit ac89cef into trunk Aug 28, 2024
57 checks passed
@coder-karen coder-karen deleted the add/content-options-to-classic-theme-helper-package branch August 28, 2024 07:57
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Aug 28, 2024
@github-actions github-actions bot added this to the jetpack/13.8 milestone Aug 28, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Theme Tools [Package] Classic Theme Helper [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants