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

Remove yoast-components #21344

Merged
merged 3 commits into from
Apr 29, 2024
Merged

Remove yoast-components #21344

merged 3 commits into from
Apr 29, 2024

Conversation

igorschoester
Copy link
Member

@igorschoester igorschoester commented Apr 28, 2024

Context

  • Clean-up old & unused package

Summary

This PR can be summarized in the following changelog entry:

  • Removes yoast-components from this repository.
  • [wordpress-seo other] Removes the yoast-components-package script.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Perhaps search for usages yourself
  • Double check asset manager using yoast-components, though pointing to @yoast/components
    • On both pages below, verify there is no missing script
    • Visit installation success page: admin.php?page=wpseo_installation_successful_free
    • Visit workouts page
  • Smoke test
  • Verify yoast-components is archived under libraries:
  • Verify in the editor that we no longer expose yoast.components

Compatibility with Premium
These all have script dependencies on WPSEO_Admin_Asset_Manager::PREFIX . 'yoast-components', which should mean @yoast/components.
But lets make sure, by going there and verifying no missing script/errors.

  • Activate Premium
  • Visit the frontend and open the Frontend inspector
  • Edit a post in the block editor
  • While editing a post:
    • Check the social previews
    • Change the slug, and verify the redirect notification works
    • Add a Premium block like the Estimated reading time
  • Edit a post in Elementor
  • Go to the workouts

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 #20243

@igorschoester igorschoester added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Apr 28, 2024
Copy link

@igorschoester Please be aware that following packages have been abandoned and are not actively maintained anymore:

Package name Path
@yoast/babel-preset packages/babel-preset
@yoast/components packages/components
@yoast/e2e-tests packages/e2e-tests
@yoast/helpers packages/helpers
@yoast/jest-preset packages/jest-preset
@yoast/style-guide packages/style-guide

Please consider using the other packages instead.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 1a015b2655aaf1617a4931bb08e7fb608661a603

Details

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

Totals Coverage Status
Change from base Build ebae401160dbb57f6d2a8da5a0b29c42cda002dd: 0.03%
Covered Lines: 28465
Relevant Lines: 54954

💛 - Coveralls

@igorschoester igorschoester mentioned this pull request Apr 28, 2024
18 tasks
Copy link
Contributor

@thijsoo thijsoo left a comment

Choose a reason for hiding this comment

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

Looks good to me! CR + ACC 👍

@thijsoo thijsoo merged commit 5c41934 into trunk Apr 29, 2024
36 checks passed
@thijsoo thijsoo deleted the 20243-phase-2-remove-yoast-components branch April 29, 2024 13:58
@igorschoester igorschoester added this to the 22.7 milestone Apr 29, 2024
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.

Phase 2: remove yoast-components
3 participants