Skip to content

Deprecate IssueLabelToken in favor of experimental IssueLabel - #8812

Open
tay1orjones wants to merge 2 commits into
mainfrom
deprecate-issue-label-token
Open

tay1orjones wants to merge 2 commits into
mainfrom
deprecate-issue-label-token

Conversation

@tay1orjones

@tay1orjones tay1orjones commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

Closes https://github.com/github/primer/issues/6367

Marks IssueLabelToken as deprecated and points consumers at the experimental IssueLabel. Runtime behavior is unchanged, so existing instances keep working. Promoting IssueLabel to the main bundle and removing IssueLabelToken are breaking and left for the next major (per the issue discussion).

Changelog

New

N/A

Changed

  • @deprecated JSDoc on IssueLabelToken and IssueLabelTokenProps, with prop mapping to IssueLabel (fillColor carries over; no text/size/isSelected/onRemove/hideRemoveButton; children replaces text)
  • IssueLabelToken marked deprecated in Token.docs.json

Removed

N/A

Rollout strategy

  • No changes needed in github/github-ui

Testing & Reviewing

Comment and docs-metadata only. Check that the migration notes accurately describe the differences between IssueLabelToken and IssueLabel.

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
@tay1orjones
tay1orjones requested a review from a team as a code owner November 20, 2026 17:30
@tay1orjones tay1orjones added the skip changeset This change does not need a changelog label Nov 20, 2026
@tay1orjones
tay1orjones requested review from francinelucca and a balanced review from Copilot November 20, 2026 17:30
@changeset-bot

changeset-bot Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 5638efc

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

@tay1orjones tay1orjones removed the skip changeset This change does not need a changelog label Nov 20, 2026
@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 Nov 20, 2026
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Action required

👋 Hi, this pull request contains changes to the source code that github/github-ui depends on. If you are GitHub staff, test these changes with github/github-ui using the integration workflow. Check the integration testing docs for step-by-step instructions. Or, apply the integration-tests: skipped manually label to skip these checks.

@tay1orjones tay1orjones added the integration-tests: skipped manually Changes in this PR do not require an integration test label Nov 20, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 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 IssueLabelToken as 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>

This branch was successfully deployed

2 active deployments
storybook-preview-8812 — 5638efcd Deployed Nov 20, 2026 by github-actions[bot]
github-pages — 5638efcd Deployed Nov 20, 2026 by tay1orjones via deploy-preview #34482
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 integration-tests: skipped manually Changes in this PR do not require an integration test

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants