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

[WordAds]: Add sticky ad format settings #40911

Open
wants to merge 4 commits into
base: trunk
Choose a base branch
from

Conversation

Alameen688
Copy link
Contributor

@Alameen688 Alameen688 commented Jan 9, 2025

Proposed changes:

This PR includes ad settings to manage the sticky ad formats included in the IPW migration code.
(IT'S TO BE USED WHEN WE ACTIVATE THE MIGRATED FORMAT, WE CAN'T MERGE NOW AFAIK)

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

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

Testing instructions:

settings
  • Go to Ad settings via Jetpack > Settings >Monetize > Ads
  • You should be able to see both Stick to bottom of the page and Stick to right side of the page options
  • Toggling on Stick to bottom of the page should enable the sticky ad format on the bottom of the page (i.e., bottom sticky) and vice versa.
  • Visit your test site including ?wordads-logging=true to see the logs (but without the query string bottom_sticky=true).
  • Confirm the bottom sticky ad runs when the setting is enabled and vice versa.
  • Toggling on Stick to right side of the page should enable sticky ad format on the right side of the page (i.e. sticky sidebar right) and vice versa.
  • Visit your test site using a theme that has space to support sticky sidebar ad (without the query string sidebar_sticky_right=true)
  • Confirm the sidebar sticky ad runs when the setting is enabled and vice versa.

Copy link
Contributor

github-actions bot commented Jan 9, 2025

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/sticky-ad-format-settings 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/sticky-ad-format-settings
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/sticky-ad-format-settings
    

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] Ad [Package] Sync [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress [Tests] Includes Tests Admin Page React-powered dashboard under the Jetpack menu labels Jan 9, 2025
Copy link
Contributor

github-actions bot commented Jan 9, 2025

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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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 semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for February 4, 2025 (scheduled code freeze on undefined).

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

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 9, 2025
@Alameen688 Alameen688 marked this pull request as ready for review January 9, 2025 07:25
@Alameen688 Alameen688 force-pushed the update/sticky-ad-format-settings branch 2 times, most recently from c2d141a to 14750a8 Compare January 13, 2025 13:48
diogoca
diogoca previously approved these changes Jan 14, 2025
Copy link
Contributor

@diogoca diogoca left a comment

Choose a reason for hiding this comment

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

Thanks for the implementation, the stick formats are toggling as expected 👍🏽

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Admin Page React-powered dashboard under the Jetpack menu [Feature] Ad [Package] Sync [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Tests] Includes Tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants