Repository navigation
Deprecate IssueLabelToken in favor of experimental IssueLabel - #8812
tay1orjones wants to merge 2 commits into
Conversation
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
🦋 Changeset detectedLatest commit: 5638efc The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
|
There was a problem hiding this comment.
🟡 Changes recommended
The deprecation uses a patch bump instead of the policy-required minor bump, and the migration guidance incorrectly lists id as unsupported.
2 open issues
What changed in this PR
Deprecates IssueLabelToken in favor of experimental IssueLabel without changing runtime behavior. Removing the old component and promoting its replacement remain deferred to a major release.
Changes:
- Adds deprecation annotations and migration guidance to the component and its props.
- Marks
IssueLabelTokenas deprecated in Token documentation metadata. - Adds a changeset announcing the deprecation.
| File | Description |
|---|---|
packages/react/src/Token/Token.docs.json |
Marks the IssueLabelToken subcomponent deprecated. |
packages/react/src/Token/IssueLabelToken.tsx |
Adds deprecation annotations and migration notes. |
.changeset/deprecate-issue-label-token.md |
Records the deprecation for release notes. |
Review effort: Balanced
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>


Closes https://github.com/github/primer/issues/6367
Marks
IssueLabelTokenas deprecated and points consumers at the experimentalIssueLabel. Runtime behavior is unchanged, so existing instances keep working. PromotingIssueLabelto the main bundle and removingIssueLabelTokenare breaking and left for the next major (per the issue discussion).Changelog
New
N/A
Changed
@deprecatedJSDoc onIssueLabelTokenandIssueLabelTokenProps, with prop mapping toIssueLabel(fillColorcarries over; notext/size/isSelected/onRemove/hideRemoveButton;childrenreplacestext)IssueLabelTokenmarkeddeprecatedinToken.docs.jsonRemoved
N/A
Rollout strategy
Testing & Reviewing
Comment and docs-metadata only. Check that the migration notes accurately describe the differences between
IssueLabelTokenandIssueLabel.