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

Fix SelectControl deprecation warning #21634

Merged
merged 1 commit into from
Sep 13, 2024

Conversation

igorschoester
Copy link
Member

@igorschoester igorschoester commented Sep 12, 2024

Context

Gutenberg 19.1 added a deprecation warning for SelectControl via WordPress/gutenberg#38730 This opts in to that behavior and adds the margin top to the ExternalLink below (therefor needing block layout to get the margin to take effect)
The __nextHasNoMarginBottom prop is available since Gutenberg 13.4, included in WP 6.0. So it should be safe to use.

Summary

This PR can be summarized in the following changelog entry:

  • Prevents a deprecation warning when editing a post with Gutenberg version 19.1.

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:

  • Edit a post
  • Open the settings panel
  • Add multiple categories
  • Verify the Primary Taxonomy picker still has the same spacing between the select and the external link below:
    image
  • Install and activate Gutenberg 19.1 or higher
  • Check again and confirm you dont get the Bottom margin styles for wp.components.SelectControl is deprecated since version 6.7 and will be removed in version 7.0. notice in console. The margins should stay the same.

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:

  • The primary taxonomy picker's distance between the select and the link below

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 #

Gutenberg added a deprecation warning for SelectControl via WordPress/gutenberg#38730
This opts in to that behavior and adds the margin top to the ExternalLink below (therefor needing block layout to get the margin to take effect)
@igorschoester igorschoester added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Sep 12, 2024
@coveralls
Copy link

Pull Request Test Coverage Report for Build 85ca584d3d223ed432f56d3257d5fb393c80d71c

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall first build on fix-primary-taxonomy-picker-deprecation-warning at 26.832%

Totals Coverage Status
Change from base Build 1584e5a2b41465c3e61e992fd324fb4563c702b5: 26.8%
Covered Lines: 3725
Relevant Lines: 12761

💛 - Coveralls

@leonidasmi leonidasmi self-assigned this Sep 13, 2024
Copy link
Contributor

@leonidasmi leonidasmi left a comment

Choose a reason for hiding this comment

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

CR + Acceptance Test is ✅

@leonidasmi leonidasmi added this to the 23.6 milestone Sep 13, 2024
@leonidasmi leonidasmi merged commit bc3a4e9 into trunk Sep 13, 2024
15 of 16 checks passed
@leonidasmi leonidasmi deleted the fix-primary-taxonomy-picker-deprecation-warning branch September 13, 2024 11:03
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.

3 participants