Skip to content

Conversation

@pksjce
Copy link
Contributor

@pksjce pksjce commented Sep 8, 2025

Part of # https://github.com/github/primer/issues/5536

Changelog

New

Changed

Removed

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

Merge checklist

@pksjce pksjce requested review from Copilot and joshblack September 8, 2025 06:20
@pksjce pksjce requested a review from a team as a code owner September 8, 2025 06:20
@changeset-bot
Copy link

changeset-bot bot commented Sep 8, 2025

🦋 Changeset detected

Latest commit: 9b1c809

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

This PR includes changesets to release 2 packages
Name Type
@primer/react Patch
@primer/styled-react Patch

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

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR moves the PointerBox component to the deprecated module as part of v38, maintaining backward compatibility by keeping the main export available while preparing for future removal.

  • Adds PointerBox to the deprecated exports module with proper deprecation documentation
  • Updates test imports to use direct component imports instead of main package exports
  • Moves Storybook documentation to the deprecated section with appropriate warnings

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
packages/react/src/deprecated/index.ts Adds PointerBox and PointerBoxProps exports to deprecated module
packages/react/src/tests/snapshots/exports.test.ts.snap Updates export snapshots reflecting PointerBox removal from main exports and addition to deprecated
packages/react/src/PointerBox/PointerBox.tsx Adds JSDoc deprecation warnings to component and type definitions
packages/react/src/PointerBox/PointerBox.test.tsx Updates import to use direct component import instead of main package export
packages/react/src/PointerBox/PointerBox.stories.tsx Moves story to deprecated section and adds deprecation notice
packages/react/src/PointerBox/PointerBox.docs.json Updates status to deprecated and changes import path to deprecated module

@github-actions
Copy link
Contributor

github-actions bot commented Sep 8, 2025

👋 Hi, this pull request contains changes to the source code that github/github depends on. If you are GitHub staff, we recommend testing these changes with github/github using the integration workflow. Thanks!

@github-actions github-actions bot added the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Sep 8, 2025
@github-actions github-actions bot requested a deployment to storybook-preview-6751 September 8, 2025 06:24 Abandoned
@github-actions
Copy link
Contributor

github-actions bot commented Sep 8, 2025

size-limit report 📦

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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@pksjce pksjce requested a review from joshblack September 9, 2025 01:07
"@primer/react": patch
---

v38: Move pointerbox to deprecated still maintaining the main export
Copy link
Member

Choose a reason for hiding this comment

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

is there a reason we want to maintain the main export or can we move to deprecated under v38 major?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So this was basically reverted because we have some main export usages

@pksjce pksjce added this pull request to the merge queue Sep 9, 2025
Merged via the queue into main with commit c8f3879 Sep 9, 2025
43 checks passed
@pksjce pksjce deleted the pk/bad-pointerbox branch September 9, 2025 03:41
@primer primer bot mentioned this pull request Sep 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants