Skip to content

Conversation

@pksjce
Copy link
Contributor

@pksjce pksjce commented Sep 4, 2025

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

In this PR, we will move Banner component to the main export. I think it is well suited to recommend for migration from Flash component.
Any advise on how to measure it in terms of our new readyness scale? @adierkens @siddharthkp ?

As a companion to this I will create a path-to-green commit on github-ui where I will move all the imports from experimental to the main one.

Copilot AI review requested due to automatic review settings September 4, 2025 05:01
@pksjce pksjce requested a review from a team as a code owner September 4, 2025 05:01
@pksjce pksjce requested a review from francinelucca September 4, 2025 05:01
@changeset-bot
Copy link

changeset-bot bot commented Sep 4, 2025

🦋 Changeset detected

Latest commit: 8f988df

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 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 moves the Banner component from the experimental package to the main export, making it part of the stable public API. This change promotes the component's readiness status while maintaining backward compatibility and updating all related documentation and test references.

  • Move Banner component exports from experimental to main package
  • Update Storybook story titles from "Experimental/Components/Banner" to "Components/Banner"
  • Update documentation and test references to reflect the new import path

Reviewed Changes

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

Show a summary per file
File Description
packages/react/src/index.ts Adds Banner exports to main package and removes PointerBox exports
packages/react/src/experimental/index.ts Removes Banner exports from experimental package
packages/react/src/Banner/Banner.stories.tsx Updates story title from experimental to main components section
packages/react/src/Banner/Banner.features.stories.tsx Updates story title from experimental to main components section
packages/react/src/Banner/Banner.examples.stories.tsx Updates story title from experimental to main components section
packages/react/src/Banner/Banner.docs.json Updates import path and story IDs for documentation
e2e/components/Banner.test.ts Updates test story IDs to match new component location

NavListDividerProps,
} from './NavList'
export {default as Overlay} from './Overlay'
export type {OverlayProps} from './Overlay'
Copy link

Copilot AI Sep 4, 2025

Choose a reason for hiding this comment

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

The removal of PointerBox exports appears to be unrelated to the Banner migration and may be an accidental change that could break existing imports.

See below for a potential fix:

export type {OverlayProps} from './Overlay'
export {default as PointerBox} from './PointerBox'

Copilot uses AI. Check for mistakes.
@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 4, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 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
Copy link
Contributor

github-actions bot commented Sep 4, 2025

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 90.45 KB (+0.7% 🔺)
packages/react/dist/browser.umd.js 90.61 KB (+0.68% 🔺)

@github-actions github-actions bot requested a deployment to storybook-preview-6720 September 4, 2025 05:08 Abandoned
@github-actions github-actions bot requested a deployment to storybook-preview-6720 September 4, 2025 06:14 Abandoned
@github-actions github-actions bot temporarily deployed to storybook-preview-6720 September 4, 2025 06:24 Inactive
@siddharthkp
Copy link
Member

Any advise on how to measure it in terms of our new readyness scale? @adierkens @siddharthkp ?

The new scale is still a proposal, so we're using alpha/beta/stable for now.

Buuuut, if you want here are the 17 items in the current criteria today, each criterion is worth 1 point.

@pksjce pksjce added this pull request to the merge queue Sep 4, 2025
Merged via the queue into main with commit 0466819 Sep 4, 2025
63 of 65 checks passed
@pksjce pksjce deleted the pk/good-banner branch September 4, 2025 23:35
@primer primer bot mentioned this pull request Sep 4, 2025
joshblack added a commit that referenced this pull request Sep 5, 2025
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.

4 participants