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

Photon: update filter docblock to match possible types #36731

Merged
merged 1 commit into from
Apr 4, 2024

Conversation

jeherve
Copy link
Member

@jeherve jeherve commented Apr 4, 2024

Proposed changes:

If you browse through that file, you will see that we can pass a string, an array, or even null to jetpack_photon_skip_image. Let's update the docblock to reflect 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

  • N/A

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

  • No

Testing instructions:

Not much to test here. I would only recommend to browse for usage of jetpack_photon_skip_image and see that it matches the updated docblock.

If you browse through that file, you will see that we can pass a string, an array, or even null to jetpack_photon_skip_image
@jeherve jeherve added [Status] Needs Review To request a review from Crew. Label will be renamed soon. [Type] Janitorial [Pri] Low [Status] Needs Team Review labels Apr 4, 2024
@jeherve jeherve requested a review from a team April 4, 2024 07:50
@jeherve jeherve self-assigned this Apr 4, 2024
Copy link
Contributor

github-actions bot commented Apr 4, 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 update/photon-filter-doc branch.

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

    bin/jetpack-downloader test jetpack update/photon-filter-doc
    

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] Photon aka "Image CDN". Feature developed in the Image CDN package and shipped in multiple plugins [Package] Image CDN labels Apr 4, 2024
Copy link
Contributor

github-actions bot commented Apr 4, 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.

@jeherve jeherve enabled auto-merge (squash) April 4, 2024 09:48
@jeherve jeherve merged commit 8c7ff62 into trunk Apr 4, 2024
61 of 63 checks passed
@jeherve jeherve deleted the update/photon-filter-doc branch April 4, 2024 13:07
@github-actions github-actions bot removed [Status] Needs Team Review [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Apr 4, 2024
TimBroddin pushed a commit that referenced this pull request Apr 10, 2024
If you browse through that file, you will see that we can pass a string, an array, or even null to jetpack_photon_skip_image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Photon aka "Image CDN". Feature developed in the Image CDN package and shipped in multiple plugins [Package] Image CDN [Pri] Low [Type] Janitorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants