Skip to content

Announce the addition of the Google docs add on to Free & Premium #4603#22376

Merged
JorPV merged 14 commits intotrunkfrom
4603-announce-google-docs-addons-show-only-in-admin-pages
Jun 26, 2025
Merged

Announce the addition of the Google docs add on to Free & Premium #4603#22376
JorPV merged 14 commits intotrunkfrom
4603-announce-google-docs-addons-show-only-in-admin-pages

Conversation

@mykola
Copy link
Copy Markdown
Contributor

@mykola mykola commented Jun 25, 2025

Show Announce modal only for Yoast Admin pages.

Context

  • Shows announce of the Google Docs add-on only on Yoast Settings page.

Summary

This PR can be summarized in the following changelog entry:

  • Fixes a bug where the Google Docs add-on announcement modals appeared on all admin pages.

Relevant technical choices:

  • Use conditional class to show only on YOast Settings page.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Check that Yoast SEO Google Docs Add-On - incl. in Premium upsell modal is displayed in for Free.

  • Deactivate Yoast Premium plugin if it's active.
  • Deactivate the free plugin.
  • Open any sql editor or use wp db query wp-cli command and remove _yoast_wpseo_introductions meta_key from wp_usermeta table:
    DELETE FROM `wp_usermeta` WHERE `meta_key` = '_yoast_wpseo_introductions'
  • Activate the free plugin.
  • Make sure that the dialog not displayed.
  • Go to Yoast Settings page.
  • Make sure that Yoast SEO Google Docs Add-On - incl. in Premium upsell modal is displayed and fit the design:
    image
  • Click on Unlock with Yoast SEO Premium button and make sure that url is opened in new tab (the pages should be created and active before tests).

Check that Yoast SEO Google Docs Add-On - incl. in Premium upsell modal is displayed in for Premium.

  • Activate Yoast Premium plugin.
  • Install previous version of Free plugin (or just build from trunk if it's not merged yet)
  • Open any sql editor or use wp db query wp-cli command and remove _yoast_wpseo_introductions meta_key from wp_usermeta table:
    DELETE FROM `wp_usermeta` WHERE `meta_key` = '_yoast_wpseo_introductions'
  • Upgrade free plugin to the current version from this PR.
  • Make sure that the dialog not displayed.
  • Navigate to Yoast Settings page.
  • Make sure that Yoast SEO Google Docs Add-On - incl. in Premium upsell modal is displayed and fit the design:
    image
  • Click on Get started for free button and make sure that url is opened in new tab (the pages should be created and active before tests).

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

  • No other impact.

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes #4603

@mykola mykola added the changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog label Jun 25, 2025
@mykola mykola marked this pull request as ready for review June 25, 2025 11:22
@coveralls
Copy link
Copy Markdown

coveralls commented Jun 25, 2025

Pull Request Test Coverage Report for Build b0d96a1968c1e2a4deeb4ffed42322481bcd1e3d

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 5 of 5 (100.0%) changed or added relevant lines in 1 file are covered.
  • 30 unchanged lines in 3 files lost coverage.
  • Overall coverage decreased (-0.008%) to 53.885%

Files with Coverage Reduction New Missed Lines %
inc/class-post-type.php 2 68.42%
src/helpers/post-type-helper.php 3 17.86%
src/llms-txt/infrastructure/markdown-services/content-types-collector.php 25 72.53%
Totals Coverage Status
Change from base Build 7f13637735c91788cfc2d1721395816a9e9168c3: -0.008%
Covered Lines: 30487
Relevant Lines: 57543

💛 - Coveralls

@mykola mykola marked this pull request as draft June 25, 2025 13:02
@mykola mykola marked this pull request as ready for review June 25, 2025 13:45
Copy link
Copy Markdown
Contributor

@JorPV JorPV left a comment

Choose a reason for hiding this comment

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

Just a small adjustment :)

Comment thread packages/js/src/shared-admin/components/google-docs-addon-upsell.js Outdated
@JorPV
Copy link
Copy Markdown
Contributor

JorPV commented Jun 25, 2025

@mykola there is an error comming form the safeCreateInterpolateElement() function.

image
image

Comment thread packages/js/src/shared-admin/components/google-docs-addon-upsell.js
@JorPV JorPV modified the milestone: 25.5 Jun 26, 2025
@JorPV
Copy link
Copy Markdown
Contributor

JorPV commented Jun 26, 2025

It looks good to me! 👍🏼

@JorPV JorPV merged commit 389a00f into trunk Jun 26, 2025
42 checks passed
@JorPV JorPV deleted the 4603-announce-google-docs-addons-show-only-in-admin-pages branch June 26, 2025 11:56
@marinakoleva marinakoleva added changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog and removed changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog labels Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants