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

Components: Remove "experimental" designation for CustomSelectControlV2 #61078

Conversation

fullofcaffeine
Copy link
Member

Issue: #59418.

What?

This is part of a larger effort to remove __experimental prefix from all "experimental" components, effectively promoting them to regular stable components. See the related issue for more context.

Why?

The strategy of prefixing exports with __experimental has become deprecated after the introduction of private APIs.

How?

  1. Export it from components without the __experimental prefix;
  2. Keep the old __experimental export for backwards compatibility;
  3. Change all imports of the old __experimental in GB and components to the one without the prefix (including in storybook stories). Also, update the docs to refer to the new unprefixed component;
  4. Add the component storybook id (get it from the storybook URL) to the PREVIOUSLY_EXPERIMENTAL_COMPONENTS const array in manager-head.html so that old experimental story paths are redirected to the new one;
  5. Add a changelog for the change.

@fullofcaffeine fullofcaffeine added [Type] Code Quality Issues or PRs that relate to code quality [Package] Components /packages/components labels Apr 25, 2024
@fullofcaffeine fullofcaffeine self-assigned this Apr 25, 2024
@fullofcaffeine
Copy link
Member Author

Note to self: follow-up this (or work in parallel) with a PR to change the default exported implementation to the new legacy adapter from V2. I started playing with it in this commit: 752a07f, and found some API problems with the new adapter.

@fullofcaffeine fullofcaffeine changed the title Components: Remove "experimental" designation for CustomSelectControlV2 Components: Assess stabilization of CustomSelectControlV2 Apr 30, 2024
@fullofcaffeine fullofcaffeine changed the title Components: Assess stabilization of CustomSelectControlV2 Components: Remove "experiental" designation for CustomSelectControlV2 Apr 30, 2024
@fullofcaffeine fullofcaffeine changed the title Components: Remove "experiental" designation for CustomSelectControlV2 Components: Remove "experimental" designation for CustomSelectControlV2 Apr 30, 2024
@fullofcaffeine fullofcaffeine marked this pull request as ready for review April 30, 2024 09:50
Copy link

github-actions bot commented Apr 30, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: fullofcaffeine <[email protected]>
Co-authored-by: mirka <[email protected]>
Co-authored-by: tyxla <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@fullofcaffeine fullofcaffeine force-pushed the remove/wp-components-experimental-designation-for-customselectcontrolv2 branch from 1c1b77e to b1e29b4 Compare April 30, 2024 09:59
@fullofcaffeine fullofcaffeine force-pushed the remove/wp-components-experimental-designation-for-customselectcontrolv2 branch from b1e29b4 to 82d2af9 Compare April 30, 2024 10:45
Copy link
Member

@tyxla tyxla left a comment

Choose a reason for hiding this comment

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

Should we also remove the experimental callout from the component README?

This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.

Otherwise, looks good to me 👍

@fullofcaffeine fullofcaffeine merged commit 2f6b916 into trunk Apr 30, 2024
44 of 61 checks passed
@fullofcaffeine fullofcaffeine deleted the remove/wp-components-experimental-designation-for-customselectcontrolv2 branch April 30, 2024 14:23
@github-actions github-actions bot added this to the Gutenberg 18.3 milestone Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Components /packages/components [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants