Skip to content

Conversation

pksjce
Copy link
Contributor

@pksjce pksjce commented Sep 2, 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

@Copilot Copilot AI review requested due to automatic review settings September 2, 2025 03:41
@pksjce pksjce requested a review from a team as a code owner September 2, 2025 03:41
@pksjce pksjce requested a review from jonrohan September 2, 2025 03:41
Copy link

changeset-bot bot commented Sep 2, 2025

🦋 Changeset detected

Latest commit: cbbcfb0

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 Major
@primer/styled-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

Copy link
Contributor

@Copilot 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 deprecates the PointerBox component as part of v38, moving it from the main component exports to the deprecated bundle. The component is being phased out in favor of more modern alternatives like Overlay or Position + Box with caret.

  • Moves PointerBox exports from main index to deprecated bundle
  • Adds deprecation JSDoc comments to component and type definitions
  • Updates Storybook configuration to categorize under "Deprecated/Components"
  • Changes component status from "alpha" to "deprecated" in documentation metadata

Reviewed Changes

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

Show a summary per file
File Description
packages/react/src/index.ts Removes PointerBox exports from main bundle
packages/react/src/deprecated/index.ts Adds PointerBox exports to deprecated bundle
packages/react/src/PointerBox/PointerBox.tsx Adds JSDoc deprecation warnings to component and types
packages/react/src/PointerBox/PointerBox.stories.tsx Updates Storybook category and adds deprecation notice
packages/react/src/PointerBox/PointerBox.docs.json Changes status from "alpha" to "deprecated"

parameters: {
docs: {
description: {
component: 'PointerBox is deprecated and will be removed in a future major release. Consider using Overlay.',
Copy link
Preview

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

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

The deprecation message is inconsistent with the JSDoc comments in the component file. The JSDoc suggests 'Overlay or Position + Box with a caret' while this only mentions 'Overlay'. Consider aligning the messaging to match the more detailed alternative provided in the JSDoc comments.

Suggested change
component: 'PointerBox is deprecated and will be removed in a future major release. Consider using Overlay.',
component: 'PointerBox is deprecated and will be removed in a future major release. Consider using Overlay or Position + Box with a caret.',

Copilot uses AI. Check for mistakes.

Updated versioning for @primer/react from patch to major due to deprecation of PointerBox component.
@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 2, 2025
Copy link
Contributor

github-actions bot commented Sep 2, 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 requested a deployment to storybook-preview-6704 September 2, 2025 03:45 Abandoned
Copy link
Contributor

github-actions bot commented Sep 2, 2025

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 89.25 KB (-0.77% 🔽)
packages/react/dist/browser.umd.js 89.33 KB (-0.86% 🔽)

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.

1 participant