Skip to content

BranchName API proposal#7993

Draft
siddharthkp wants to merge 5 commits into
mainfrom
siddharthkp/branchname-trailing-action-component
Draft

BranchName API proposal#7993
siddharthkp wants to merge 5 commits into
mainfrom
siddharthkp/branchname-trailing-action-component

Conversation

@siddharthkp

@siddharthkp siddharthkp commented Jun 15, 2026

Copy link
Copy Markdown
Member

Closes #

API proposal document for upstreaming patterns from production usage into the BranchName component:

  1. Leading visual — a branch/tag icon before the name
  2. Trailing action — copy button, branch switcher menu
  3. Description tooltip — shows owner/repo:branch context

The proposal recommends Option A — Compound component based on analysis of github-ui usage patterns.

Changelog

New

  • API proposal document at packages/react/src/BranchName/BranchName.api-proposal.md

Changed

None

Removed

None

Rollout strategy

  • None; this is a proposal document only, no code changes

Testing & Reviewing

Review the proposal document for API design feedback.

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Added/updated previews (Storybook)
  • Changes are SSR compatible
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge
  • (GitHub staff only) Integration tests pass at github/github-ui

siddharthkp and others added 5 commits June 10, 2026 11:55
@siddharthkp
Add BranchName WithTrailingAction story
a04b7bd 
Demonstrate a trailing action pattern (copy button) for BranchName,
serving as a reference for future implementation work.

Add WithTrailingActionMenu story with SelectPanel

Demonstrates branch switching via SelectPanel anchored to BranchName,
showing the 'Change base branch' pattern.

Remove overflow:hidden to prevent focus ring clipping
@siddharthkp
Add e2e tests for WithTrailingAction stories
aad16e8
@siddharthkp @github-actions
test(vrt): update snapshots
fd4ede3
@siddharthkp
Use announce() instead of rendered Announce component
1a98046
@siddharthkp
Add BranchName API proposal
8d3071f
@changeset-bot

changeset-bot Bot commented Jun 15, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 8d3071f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions Bot added staff Author is a staff member integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm labels Jun 15, 2026
@github-actions

github-actions Bot commented Jun 15, 2026

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.

To publish a canary release for integration testing, apply the Canary Release label to this PR.

@primer

primer Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

🤖 Lint issues have been automatically fixed and committed to this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Awaiting requested review from Copilot Copilot will automatically review once the pull request is marked ready for review

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm staff Author is a staff member

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@siddharthkp