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

Navigator: mark experimental exports as deprecated #65802

Merged
merged 3 commits into from
Oct 2, 2024

Conversation

ciampo
Copy link
Contributor

@ciampo ciampo commented Oct 1, 2024

What?

Part of #59418

This PR marks the following exports from @wordpress/components as deprecated: __experimentalNavigatorProvider, __experimentalNavigatorScreen, __experimentalNavigatorButton, __experimentalNavigatorBackButton, __experimentalNavigatorToParentButton and __experimentalUseNavigator.

Why?

The Navigator is not exported also as a stable API. The stable export should be preferred over the __experimental one.

How?

Following the passive deprecation strategy highlighted in #61099

Testing Instructions

  • Make sure there are no usages left of the deprecated components in the codebase
  • Make sure that the @deprecated JSDoc tag is applied and shows as expected on the deprecated exports
  • No runtime changes

@ciampo ciampo added [Type] Code Quality Issues or PRs that relate to code quality [Package] Components /packages/components labels Oct 1, 2024
@ciampo ciampo self-assigned this Oct 1, 2024
@ciampo ciampo requested a review from ajitbohra as a code owner October 1, 2024 16:42
@ciampo ciampo requested a review from a team October 1, 2024 16:42
Copy link

github-actions bot commented Oct 1, 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: ciampo <[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.

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.

Looks good, just have one question on the deprecation comments.

packages/components/src/index.ts Outdated Show resolved Hide resolved
@ciampo ciampo force-pushed the feat/navigator-deprecate branch from 6684603 to bd9ea19 Compare October 2, 2024 11:20
@ciampo ciampo requested a review from tyxla October 2, 2024 11:21
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.

Looks great, thanks 🚀

Copy link

github-actions bot commented Oct 2, 2024

Flaky tests detected in bd9ea19.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11142852428
📝 Reported issues:

@ciampo ciampo merged commit ce30c18 into trunk Oct 2, 2024
66 checks passed
@ciampo ciampo deleted the feat/navigator-deprecate branch October 2, 2024 12:22
@github-actions github-actions bot added this to the Gutenberg 19.4 milestone Oct 2, 2024
huubl pushed a commit to huubl/gutenberg that referenced this pull request Oct 2, 2024
* Navigator: mark experimental exports as deprecated

* CHANGELOG

* Update JSDocs deprecation alternatives suggestions

---

Co-authored-by: ciampo <[email protected]>
Co-authored-by: tyxla <[email protected]>
huubl added a commit to huubl/gutenberg that referenced this pull request Oct 2, 2024
draganescu pushed a commit that referenced this pull request Oct 2, 2024
* Navigator: mark experimental exports as deprecated

* CHANGELOG

* Update JSDocs deprecation alternatives suggestions

---

Co-authored-by: ciampo <[email protected]>
Co-authored-by: tyxla <[email protected]>
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.

2 participants