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

Update toolings and dependencies in yoastseo package #20651

Merged
merged 91 commits into from
Apr 2, 2024
Merged

Conversation

FAMarfuaty
Copy link
Contributor

@FAMarfuaty FAMarfuaty commented Sep 20, 2023

Context

Summary

This PR can be summarized in the following changelog entry:

  • Updates the toolings in yoastseo package.
  • [yoastseo] Updates the dependencies, improves the configuration and cleans up old code.
  • [shopify-seo] Updates the toolings in yoastseo package.
  • [search-metadata-previews] Ignores import/no-unresolved ESLint rule when importing from yoastseo package.

Relevant technical choices:

  • Modified the ESLint config files in some packages so that the GH action LintJS pass:
    • The ESLint configuration specific to yoastseo package was moved to the .eslintrc.js inside the package
    • Adjusted the ESLint config inside @yoast/wordpress-seo and @yoast/search-metadata-previews package so that we ignore import/no-unresolved rule when importing from yoastseo package
  • Simplified and updated babel configuration
  • Updated and improved the ESLint configuration and Jest configuration
  • Upgraded the dependencies. For more detailed documentation, refer to the following page.
  • Updated the scripts so that we don't use grunt anymore, except for retrieving the premium configuration which will be tackled in a separate PR in the future

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

For acceptance testing for the developer

  • Make sure that all tests pass in Free branch when running yarn test
  • Make sure that no errors in the linting when running yarn lint
  • Make sure that all tests in add-ons pass after requiring the Free branch

Test in Free

  • Install and activate Yoast SEO (or build the plugin)
  • Smoke test the analysis and make sure that:
    • there is no error anywhere including in the console
    • the analysis still works

Test in the add-ons (Premium, Local SEO, Video SEO, WooCommerce SEO, News SEO)

  • Install and activate the add-ons
  • Smoke test the add-ons functionality and make sure that:
    • there is no error anywhere including in the console
    • the analysis still works

Test in Shopify

  • Smoke test the analysis in Shopify and make sure that it still works and there is no error in the console

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 (Block/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:

  • No further impact other than what's included in the testing instruction above.

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.

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 #

mhkuu and others added 30 commits May 26, 2023 11:30
@coveralls
Copy link

coveralls commented Mar 12, 2024

Pull Request Test Coverage Report for Build 7a2ab1b4f91c508c2ff4a90ffffb29ba5b83d461

Details

  • 78 of 78 (100.0%) changed or added relevant lines in 18 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.6%) to 54.786%

Totals Coverage Status
Change from base Build 6d81e2d8cec02f54e26aa74dd6da4226d6355b18: 0.6%
Covered Lines: 30043
Relevant Lines: 55078

💛 - Coveralls

@FAMarfuaty FAMarfuaty added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Mar 13, 2024
@FAMarfuaty FAMarfuaty added the Shopify This PR impacts Shopify. label Mar 13, 2024
@FAMarfuaty FAMarfuaty changed the title Releasing yoastseo Update toolings and dependencies in yoastseo package Mar 13, 2024
@FAMarfuaty FAMarfuaty marked this pull request as ready for review March 18, 2024 14:35
@mykola mykola merged commit 434b6d0 into trunk Apr 2, 2024
18 checks passed
@mykola mykola deleted the releasing-yoastseo branch April 2, 2024 13:23
@mhkuu mhkuu added this to the 22.5 milestone Apr 3, 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 Shopify This PR impacts Shopify.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants