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 Social Menu code to Classic Theme Helper package #38243

Merged
merged 7 commits into from
Jul 10, 2024

Conversation

coder-karen
Copy link
Contributor

@coder-karen coder-karen commented Jul 8, 2024

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

Proposed changes:

  • Moved the main file social-menus.php and the social-menus folder containing SVG, PHP and CSS 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)
  • There is no WebPack build added, as there is none in the Jetpack plugin either for this feature.

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/393

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

No.

Testing instructions:

  • The package 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.
Copy link
Contributor

github-actions bot commented Jul 8, 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/social-menu-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/social-menu-to-classic-theme-helper-package
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/social-menu-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
@github-actions github-actions bot added [Feature] Theme Tools [Package] Classic Theme Helper [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Jul 8, 2024
Copy link
Contributor

github-actions bot commented Jul 8, 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 August 6, 2024 (scheduled code freeze on August 5, 2024).

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

@coder-karen coder-karen marked this pull request as ready for review July 8, 2024 19:27
@coder-karen coder-karen added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] In Progress labels Jul 8, 2024
@coder-karen coder-karen requested a review from a team July 8, 2024 19:28
/*
* Add Mastodon instances to this array.
*/
$mastodon_instance_list = jetpack_mastodon_get_instance_list();
Copy link
Contributor

Choose a reason for hiding this comment

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

This function seems to be coming from jetpack plugin global functions.
And is what phan is marking as PhanUndeclaredFunction.

I don't think this will be accessible if the package is used in a different plugin than jetpack

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes I noticed that too - I could presumably copy the function over if needed, I haven't looked into it much though just yet. I won't be dealing with Phan issues until the next PR (I made some minor fixes here, added that suppression, but can't test properly until I'm requiring the code from the package).

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.

Since this is just moving code to the Classic Theme Helper Package changes look good.

@coder-karen coder-karen merged commit 4dc8e34 into trunk Jul 10, 2024
58 checks passed
@coder-karen coder-karen deleted the add/social-menu-to-classic-theme-helper-package branch July 10, 2024 08:15
@github-actions github-actions bot removed the [Status] Needs Review To request a review from Crew. Label will be renamed soon. label Jul 10, 2024
@github-actions github-actions bot added this to the jetpack/13.7 milestone Jul 10, 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/
2 participants