Skip to content

Conversation

llastflowers
Copy link
Contributor

@llastflowers llastflowers commented Aug 26, 2025

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

Current sx usage: 5

sx usages are only in repos other than github-ui; those usages have been added to the tracking issue

Changelog

Removed

Remove support for sx from the CircleBadge component, and associated stories, docs, and tests

Rollout strategy

  • Major release; if selected, include a written rollout or migration plan

We are using the @primer/styled-react component to mitigate removing sx usage. We will make sure usage is updated upstream before merging.

Merge checklist

@llastflowers llastflowers self-assigned this Aug 26, 2025
Copy link

changeset-bot bot commented Aug 26, 2025

🦋 Changeset detected

Latest commit: 9f01823

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

@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 Aug 26, 2025
Copy link
Contributor

👋 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!

Copy link
Contributor

github-actions bot commented Aug 26, 2025

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 89.52 KB (+0.12% 🔺)
packages/react/dist/browser.umd.js 89.66 KB (+0.04% 🔺)

@github-actions github-actions bot requested a deployment to storybook-preview-6673 August 26, 2025 17:40 Abandoned
@github-actions github-actions bot temporarily deployed to storybook-preview-6673 August 26, 2025 17:49 Inactive
@llastflowers llastflowers marked this pull request as ready for review September 5, 2025 16:58
@Copilot Copilot AI review requested due to automatic review settings September 5, 2025 16:58
@llastflowers llastflowers requested a review from a team as a code owner September 5, 2025 16:58
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 pull request removes the deprecated sx prop support from the CircleBadge component as part of a broader effort to eliminate sx usage across Primer React components. The change is part of a major version release with an existing migration strategy in place.

Key changes:

  • Removes sx prop support from CircleBadge component type definitions and styling
  • Updates component documentation to reflect the removed prop
  • Updates test snapshots to reflect the styling changes

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
packages/react/src/CircleBadge/CircleBadge.tsx Removes sx prop from component interface and styled component implementation
packages/react/src/CircleBadge/CircleBadge.docs.json Removes sx prop from component documentation
packages/react/src/CircleBadge/__snapshots__/CircleBadge.test.tsx.snap Updates test snapshots to reflect new CSS class names after sx removal
.changeset/cool-apricots-sneeze.md Adds changeset entry documenting the breaking change for major version release

Copy link
Member

@francinelucca francinelucca left a comment

Choose a reason for hiding this comment

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

Looks like CircleBadge is still a styled component 🤔 , though it is up for deprecation, I'm not sure if we care to migrate? cc @TylerJDev
Also, let's make sure to run integration checks before merging

@llastflowers
Copy link
Contributor Author

llastflowers commented Sep 5, 2025

Looks like CircleBadge is still a styled component 🤔 , though it is up for deprecation, I'm not sure if we care to migrate? cc @TylerJDev Also, let's make sure to run integration checks before merging

Tyler confirmed in the issue comments that we should just migrate this one, since the removal might not happen in v38 👍

@francinelucca
Copy link
Member

francinelucca commented Sep 5, 2025

Tyler confirmed in the https://github.com/github/primer/issues/5780#issuecomment-3254503394 that we should just migrate this one, since the removal might not happen in v38 👍

should we migrate it to css modules then?

@github-actions github-actions bot requested a deployment to storybook-preview-6673 September 23, 2025 14:58 Abandoned
@github-actions github-actions bot temporarily deployed to storybook-preview-6673 September 23, 2025 15:06 Inactive
@github-actions github-actions bot requested a deployment to storybook-preview-6673 September 23, 2025 15:49 Abandoned
@primer-integration
Copy link

👋 Hi from github/github-ui! Your integration PR is ready: https://github.com/github/github-ui/pull/3086

@primer-integration
Copy link

🟢 ci completed with status success.

@github-actions github-actions bot added integration-tests: passing Changes in this PR do NOT cause breaking changes in gh/gh and removed integration-tests: failing Changes in this PR cause breaking changes in gh/gh labels Sep 23, 2025
Copy link
Contributor

👋 Hi, there are new commits since the last successful integration test. We recommend running the integration workflow once more, unless you are sure the new changes do not affect github/github. 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 23, 2025
@github-actions github-actions bot temporarily deployed to storybook-preview-6673 September 23, 2025 19:08 Inactive
@github-actions github-actions bot added integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm and removed integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm labels Sep 29, 2025
Copy link
Contributor

👋 Hi, there are new commits since the last successful integration test. We recommend running the integration workflow once more, unless you are sure the new changes do not affect github/github. Thanks!

@francinelucca francinelucca added this pull request to the merge queue Sep 29, 2025
Merged via the queue into main with commit 19befd6 Sep 29, 2025
42 checks passed
@francinelucca francinelucca deleted the llastflowers/5780/no-sx-CircleBadge branch September 29, 2025 18:23
@primer primer bot mentioned this pull request Sep 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

integration-tests: passing Changes in this PR do NOT cause breaking changes in gh/gh 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.

3 participants