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.

Sign up for GitHub

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

Jump to bottom

Tooltip: Do not export all types publicly in the experimental bundle #5064

Merged
merged 5 commits into from
Oct 7, 2024
Merged

Tooltip: Do not export all types publicly in the experimental bundle #5064

merged 5 commits into from
Oct 7, 2024

Conversation

broccolinisoup
Copy link
Member

@broccolinisoup broccolinisoup commented Oct 4, 2024 •
edited
Loading

Changelog

New

Changed

  • We don't need to export TriggerPropsType since it is only used in Tooltip component.

Removed

  • Remove TriggerPropsType, TooltipContext, TooltipDirection from the experimental export

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Testing & Reviewing

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Oct 4, 2024 •
edited
Loading

🦋 Changeset detected

Latest commit: fa0b38a

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 Minor

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 Oct 4, 2024
@github-actions github-actions bot temporarily deployed to storybook-preview-5064 October 4, 2024 00:26 Inactive
@github-actions github-actions bot temporarily deployed to storybook-preview-5064 October 4, 2024 01:21 Inactive
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 4, 2024 •
edited
Loading

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 96.7 KB (0%)
packages/react/dist/browser.umd.js 97.02 KB (0%)

@github-actions github-actions bot temporarily deployed to storybook-preview-5064 October 4, 2024 01:51 Inactive
@broccolinisoup broccolinisoup marked this pull request as ready for review October 4, 2024 04:34
@broccolinisoup broccolinisoup requested a review from a team as a code owner October 4, 2024 04:34
@broccolinisoup broccolinisoup changed the title Do not export all types publicly in the experimental bundle Tooltip: Do not export all types publicly in the experimental bundle Oct 4, 2024
broccolinisoup
broccolinisoup commented Oct 4, 2024
View reviewed changes
.changeset/eight-avocados-lick.md Outdated
@@ -0,0 +1,5 @@
---
"@primer/react": patch
Copy link
Member Author

Choose a reason for hiding this comment

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

This is technically a breaking change since we remove export but there is no usage internally at dotcom. Should we release potentially major? Or should we just do major and include in the major release?

Copy link
Member

Choose a reason for hiding this comment

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

@broccolinisoup I think since tooltip is behind experimental/next it doesn't fall under semver so should be fine 👍 I would personally do minor since this is more around changing APIs than it would be fixing a bug but I don't know how important that is for these kind of "unstable" components 🤷

Copy link
Member Author

Choose a reason for hiding this comment

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

You are totally right!

@github-actions github-actions bot temporarily deployed to storybook-preview-5064 October 4, 2024 04:36 Inactive
joshblack
joshblack approved these changes Oct 4, 2024
View reviewed changes
.changeset/eight-avocados-lick.md Outdated
@@ -0,0 +1,5 @@
---
"@primer/react": patch
Copy link
Member

Choose a reason for hiding this comment

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

@broccolinisoup I think since tooltip is behind experimental/next it doesn't fall under semver so should be fine 👍 I would personally do minor since this is more around changing APIs than it would be fixing a bug but I don't know how important that is for these kind of "unstable" components 🤷

@primer-integration
Copy link

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

@primer-integration
Copy link

🟢 golden-jobs completed with status success.

@broccolinisoup broccolinisoup added this pull request to the merge queue Oct 7, 2024
Merged via the queue into main with commit 29f33ce Oct 7, 2024
42 checks passed
@broccolinisoup broccolinisoup deleted the bs/tooltip-exported-prop-update branch October 7, 2024 23:59
@primer primer bot mentioned this pull request Oct 7, 2024
Merged
@primer primer bot mentioned this pull request Oct 18, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshblack joshblack joshblack approved these changes

@langermank langermank Awaiting requested review from langermank langermank is a code owner automatically assigned from primer/engineer-reviewers

Assignees
No one assigned
Labels
staff Author is a staff member
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@broccolinisoup @joshblack