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

feat(react): remove deprecated components from main entrypoint #4992

Merged
merged 8 commits into from
Sep 30, 2024

Conversation

joshblack
Copy link
Member

@joshblack joshblack commented Sep 19, 2024

Closes https://github.com/github/primer/issues/4012
Closes https://github.com/github/primer/issues/4013
Closes https://github.com/github/primer/issues/4014
Closes https://github.com/github/primer/issues/4015

With https://github.com/github/github/pull/343108 merged, and the lint rule enabled, we can now remove deprecated components from the main entrypoint.

Changelog

New

Changed

  • Move the following components to deprecated:
    • Octicon
    • Pagehead
    • Tooltip (v1)
    • Dialog (v1)
  • Update tests, docs, and storybook entries to indicate that they are deprecated

Removed

Rollout strategy

  • Major release; if selected, include a written rollout or migration plan

We have created a rule to forbid importing these components from @primer/react and have migrated them to @primer/react/deprecated upstream and enabled that rule. Removing these exports should have no effect as a result as all instances of imports have been removed.

Copy link

changeset-bot bot commented Sep 19, 2024

🦋 Changeset detected

Latest commit: 9060a98

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/react Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added the staff Author is a staff member label Sep 19, 2024
@github-actions github-actions bot temporarily deployed to storybook-preview-4992 September 19, 2024 19:14 Inactive
Copy link
Contributor

github-actions bot commented Sep 19, 2024

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 96.74 KB (-1.39% 🔽)
packages/react/dist/browser.umd.js 97.13 KB (-1.24% 🔽)

@joshblack joshblack marked this pull request as ready for review September 24, 2024 17:06
@joshblack joshblack requested a review from a team as a code owner September 24, 2024 17:06
@github-actions github-actions bot temporarily deployed to storybook-preview-4992 September 24, 2024 17:09 Inactive
Copy link
Member

@jonrohan jonrohan left a comment

Choose a reason for hiding this comment

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

Changes look good 👍🏻

@joshblack joshblack added this pull request to the merge queue Sep 24, 2024
@joshblack joshblack removed this pull request from the merge queue due to a manual request Sep 24, 2024
Copy link
Member

@siddharthkp siddharthkp left a comment

Choose a reason for hiding this comment

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

I see you tested it with dotcom, that's the main thing here :)

@primer-integration
Copy link

👋 Hi from github/github! Your integration PR is ready: https://github.com/github/github/pull/344709

Merged via the queue into main with commit d1d911a Sep 30, 2024
32 checks passed
@joshblack joshblack deleted the feat/remove-deprecated-from-deprecated branch September 30, 2024 16:57
@primer primer bot mentioned this pull request Sep 30, 2024
@primer primer bot mentioned this pull request Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
staff Author is a staff member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants