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

Navigation: Prepare for hard deprecation #68158

Merged
merged 2 commits into from
Dec 20, 2024
Merged

Navigation: Prepare for hard deprecation #68158

merged 2 commits into from
Dec 20, 2024

Conversation

mirka
Copy link
Member

@mirka mirka commented Dec 20, 2024

What?

Starts logging a deprecation warning for Navigation, with an explicit end version.

Why?

After passive deprecating (#61099) this component, we have had to do maintenance work on it many times. Given the low usage, I think it would be beneficial to eventually hard remove this code from the codebase.

Testing Instructions

✅ Deprecation warning should be logged in the Storybook.
✅ Unit tests should pass.

✍️ Dev Note

The Navigation component (and all its subcomponents) are deprecated, planned for hard removal in WordPress 7.1. Use the Navigator component instead.

@mirka mirka added [Type] Code Quality Issues or PRs that relate to code quality [Package] Components /packages/components Needs Dev Note Requires a developer note for a major WordPress release cycle labels Dec 20, 2024
@mirka mirka self-assigned this Dec 20, 2024
@mirka mirka added has dev note when dev note is done (for upcoming WordPress release) and removed Needs Dev Note Requires a developer note for a major WordPress release cycle labels Dec 20, 2024
@mirka mirka force-pushed the navigation-dep-warning branch from dc7d303 to 6c8070a Compare December 20, 2024 00:36
Copy link

Flaky tests detected in 6c8070a.
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/12423238384
📝 Reported issues:

@mirka mirka marked this pull request as ready for review December 20, 2024 01:00
@mirka mirka requested a review from ajitbohra as a code owner December 20, 2024 01:00
@mirka mirka requested a review from a team December 20, 2024 01:00
Copy link

github-actions bot commented Dec 20, 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: mirka <[email protected]>
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
Contributor

@ciampo ciampo 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 add JS doc @deprecated comments here, similarly to what we've done for other components?

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.

I think we can also add a README callout as we do for other hard deprecated components:

<div class="callout callout-alert">
This component is deprecated.
</div>

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.

LGTM 👍

Thanks for writing a dev note proactively 🌟

@mirka
Copy link
Member Author

mirka commented Dec 20, 2024

Should we add JS doc @deprecated comments here, similarly to what we've done for other components?

They were marked in the source files when we first passive deprecated them. It should already be working as expected:

Deprecation warning in IDE

I think we can also add a README callout as we do for other hard deprecated components:

Also already done when we passive deprecated it 👍

@mirka mirka merged commit f4f433b into trunk Dec 20, 2024
104 of 137 checks passed
@mirka mirka deleted the navigation-dep-warning branch December 20, 2024 15:47
@github-actions github-actions bot added this to the Gutenberg 20.0 milestone Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has dev note when dev note is done (for upcoming WordPress release) [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