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

no need to show a deprecation message for should_show #21462

Conversation

vraja-pro
Copy link
Contributor

@vraja-pro vraja-pro commented Jul 4, 2024

Context

  • We want to remove deprecation message from admin pages.

Summary

This PR can be summarized in the following changelog entry:

  • Remove deprecation message for ai generator for titles and descriptions on Yoast admin pages.

Relevant technical choices:

  • The introduction collector collects all classes that implements the introduction interface, That is why I can't easily exclude the old introduction without changing the class. I ended up returning false in should_show method and dropping the deprecation message. Since it's not a class that should be used by any third party, I think it should be enough to have a deprecation annotation for that method.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Go to one of yoast admin pages.
  • Check you do not see the deprecation message for the Ai_Generate_Titles_And_Descriptions_Introduction_Upsell should_show method.

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:

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 Trivial: AI: Yoast deprecation message

@vraja-pro vraja-pro added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Jul 4, 2024
@coveralls
Copy link

coveralls commented Jul 4, 2024

Pull Request Test Coverage Report for Build 3ab714fcf6434fbaddfa42e520cc888830d8ce3e

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+4.3%) to 52.951%

Totals Coverage Status
Change from base Build 2197c662f24ce4fe327abf36f49732b2eb02db08: 4.3%
Covered Lines: 28455
Relevant Lines: 54347

💛 - Coveralls

@mhkuu mhkuu added this to the feature/fix-assessments milestone Jul 5, 2024
@leonidasmi
Copy link
Contributor

Closed in favor of this one: #21465

@leonidasmi leonidasmi closed this Jul 5, 2024
@mhkuu mhkuu removed this from the feature/fix-assessments milestone Jul 11, 2024
@mhkuu mhkuu deleted the 1667-trivial-ai-yoast-deprecation-message branch July 11, 2024 09:26
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.

None yet

4 participants