CircleBadge: deprecate the CircleBadge component
#6706
Conversation
🦋 Changeset detectedLatest commit: 1d6f536 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
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
bot
added
staff
|
👋 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! |
size-limit report 📦
|
There was a problem hiding this comment.
Pull Request Overview
This PR deprecates the CircleBadge component as part of the Primer React Design System. The component is being removed from the main exports and moved to the deprecated exports module, while adding deprecation warnings to guide users toward alternative solutions.
Key Changes
- Removes
CircleBadgefrom main package exports and moves it to the deprecated module - Adds deprecation JSDoc comments to guide users toward using specific icon imports from
@primer/octicons-react - Updates Storybook organization to move stories under the "Deprecated" section
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/react/src/index.ts | Removes CircleBadge and CircleBadgeProps exports from main package |
| packages/react/src/deprecated/index.ts | Adds CircleBadge exports to deprecated module |
| packages/styled-react/src/index.ts | Removes CircleBadge from styled-react package exports |
| packages/react/src/CircleBadge/CircleBadge.tsx | Adds deprecation JSDoc comments to component and icon |
| packages/react/src/CircleBadge/CircleBadge.docs.json | Updates component status from "alpha" to "deprecated" |
| packages/react/src/CircleBadge/CircleBadge.stories.tsx | Moves Storybook stories to "Deprecated/Components" section |
| packages/react/src/CircleBadge/CircleBadge.test.tsx | Updates import to use direct path instead of index |
| e2e/components/CircleBadge.test.ts | Updates story IDs to match new deprecated path |
| .changeset/orange-taxis-rhyme.md | Adds changeset for major version bump |
| Test snapshots | Updates snapshots to reflect component changes |
| /** | ||
| * @deprecated This component is deprecated. | ||
| * Replace component with specific icon imports from `@primer/octicons-react` and customized styling.) | ||
| */ |
There was a problem hiding this comment.
There's an extra closing parenthesis at the end of the deprecation message. It should end with 'and customized styling.' instead of 'and customized styling.)'.
Copilot uses AI. Check for mistakes.
| /** | ||
| * @deprecated This component is deprecated. | ||
| * Replace component with specific icon imports from `@primer/octicons-react` and customized styling.) | ||
| */ |
There was a problem hiding this comment.
There's an extra closing parenthesis at the end of the deprecation message. It should end with 'and customized styling.' instead of 'and customized styling.)'.
Copilot uses AI. Check for mistakes.
|
👋 Hi from github/github-ui! Your integration PR is ready: https://github.com/github/github-ui/pull/1732 |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Closes https://github.com/github/primer/issues/5535
Changelog
Changed
CircleBadgeRollout strategy
Testing & Reviewing
Merge checklist