Deprecate AvatarPair component - move to @primer/react/deprecated while maintaining backward compatibility by Copilot · Pull Request #6468 · primer/react

Copilot · 2025-08-06T03:14:54Z

This PR deprecates the AvatarPair component by moving it to the deprecated exports location, adding appropriate deprecation warnings, and removing all internal usage of the component within the repository. The component remains available from both the main package and deprecated package to avoid breaking changes.

Changes Made

Component Migration

Moved src/AvatarPair/ → src/deprecated/AvatarPair/
Updated internal import paths to work from the new location (../../Avatar, ../../SkeletonAvatar)
Added @deprecated JSDoc comments to both the component and prop types

Export Updates

Added AvatarPair exports to src/deprecated/index.ts with deprecation comments
Added AvatarPair exports to main src/index.ts with deprecation comment to maintain backward compatibility
Component available from both import paths for existing users

Internal Usage Removal

Removed AvatarPair from e2e test generation script
Removed InAnAvatarPair story from SkeletonAvatar features
Removed AvatarPair test reference from Skeletons e2e tests
Deleted AvatarPair e2e test file
Deleted results.json file (build artifact)
Updated test snapshots and documentation references

Deprecation Notices

Both the component and its prop types include deprecation warnings:

/**
 * @deprecated AvatarPair is deprecated. Please see https://github.com/github/primer/issues/5533 for migration guidance.
 */

Migration Path for Users

Current (no breaking change):

import { AvatarPair } from '@primer/react'

Alternative (explicit deprecated import):

import { AvatarPair } from '@primer/react/deprecated'

Users can continue using their existing import paths without any breaking changes, but will receive TypeScript/IDE deprecation warnings guiding them to the migration issue for alternatives.

Validation

✅ Build passes successfully
✅ TypeScript definitions include deprecation warnings
✅ Component available from both main and deprecated export paths
✅ No breaking changes for existing users
✅ No internal usage of AvatarPair remains in the codebase
✅ All files properly linted and formatted
✅ Latest main branch changes merged

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

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

changeset-bot · 2025-08-06T03:14:58Z

🦋 Changeset detected

Latest commit: ab977f5

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

Co-authored-by: pksjce <417268+pksjce@users.noreply.github.com>

github-actions · 2025-08-06T05:22:01Z

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

pksjce · 2025-08-06T05:24:34Z

@copilot - Remove usage of AvatarPair in this repo

github-actions · 2025-08-06T05:25:39Z

size-limit report 📦

Path	Size
packages/react/dist/browser.esm.js	90.28 KB (+0.09% 🔺)
packages/react/dist/browser.umd.js	90.44 KB (+0.06% 🔺)

pksjce · 2025-08-06T05:36:31Z

@copilot - Update imports in all the files in AvatarPair

Co-authored-by: pksjce <417268+pksjce@users.noreply.github.com>

Copilot · 2025-08-06T05:37:38Z

@copilot - Remove usage of AvatarPair in this repo

Completed! I've removed all usage of AvatarPair from the repository codebase:

Removed from e2e test generation script
Removed usage from SkeletonAvatar feature stories (the InAnAvatarPair story)
Deleted the AvatarPair e2e test file
Updated test snapshots and documentation references
All builds and tests now pass

The AvatarPair component itself remains available in the deprecated exports for users who need it. Commit: 0857415

pksjce · 2025-08-06T05:45:25Z

script/generate-e2e-tests.js

-        },
-      ],
-    },
-  ],


Should we do this now or when we remove the component?

I removed the AvatarPair entry from the e2e test generation script as part of deprecation since we're removing all internal usage. This helps maintain consistency - the component is deprecated and should not have new e2e tests generated. Commit: 3b760cb

pksjce · 2025-08-06T05:45:39Z

results.json

@@ -0,0 +1 @@
+[]


Delete this file

Deleted the results.json file as requested. Commit: 3b760cb

Deprecate AvatarPair component and move to @primer/react/deprecated

Co-authored-by: pksjce <417268+pksjce@users.noreply.github.com>

Copilot · 2025-08-06T05:48:29Z

@copilot - Update imports in all the files in AvatarPair

Fixed! I've updated all the incorrect import paths in the AvatarPair files:

Fixed Avatar imports in story files: ../Avatar → ../../Avatar
Fixed AvatarPair import in figma file: ../../src → ./AvatarPair

All files now have correct import paths after the component was moved to the deprecated folder. Build and TypeScript checks pass successfully. Commit: dc6ee83

francinelucca · 2025-08-07T01:22:15Z

.changeset/metal-lamps-appear.md

@@ -0,0 +1,5 @@
+---
+"@primer/react": minor


I think this is a major if we're no longer exporting through the main entrypoint

hmmm major would be removing it from the codebase no? But I get it. How does this go into v38 then?

@copilot - Export AvatarPair from both deprecated and main package so that we don't make a breaking change. Merge latest into the PR before you do this.

Added AvatarPair exports to both the main package and deprecated package to avoid breaking changes. The component is now available from both import paths:

import { AvatarPair } from '@primer/react' (with deprecation warning)

import { AvatarPair } from '@primer/react/deprecated' (with deprecation warning)

This allows existing users to continue using their current import path without breaking changes while still providing deprecation warnings. Commit: f527ee9

…f8e6-4b27-89f4-f89e53bd5015 # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

…aking change Co-authored-by: pksjce <417268+pksjce@users.noreply.github.com>

pksjce · 2025-08-08T02:44:20Z

@copilot - Update snapshots

Co-authored-by: pksjce <417268+pksjce@users.noreply.github.com>

Copilot · 2025-08-08T02:50:52Z

@copilot - Update snapshots

Updated the test snapshots to include the new AvatarPair and AvatarPairProps exports. The exports test now passes successfully. Commit: ea6c23d

…5015

Initial plan

493d2d3

Copilot AI assigned Copilot and pksjce Aug 6, 2025

Copilot started work on behalf of pksjce August 6, 2025 03:15 View session

Deprecate AvatarPair component - move to deprecated folder

44fc56f

Co-authored-by: pksjce <417268+pksjce@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Deprecate AvatarPair component and move to deprecated folder~~ Deprecate AvatarPair component - move to @primer/react/deprecated Aug 6, 2025

Copilot AI requested a review from pksjce August 6, 2025 03:31

Copilot finished work on behalf of pksjce August 6, 2025 03:31

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 6, 2025

Copilot started work on behalf of pksjce August 6, 2025 05:24 View session

Copilot AI had a problem deploying to github-pages August 6, 2025 05:28 Failure

github-actions bot requested a deployment to storybook-preview-6468 August 6, 2025 05:28 Abandoned

Remove AvatarPair usage from repository codebase

0857415

Co-authored-by: pksjce <417268+pksjce@users.noreply.github.com>

Copilot AI changed the title ~~Deprecate AvatarPair component - move to @primer/react/deprecated~~ Deprecate AvatarPair component - move to @primer/react/deprecated and remove internal usage Aug 6, 2025

Copilot finished work on behalf of pksjce August 6, 2025 05:38

Copilot started work on behalf of pksjce August 6, 2025 05:38 View session

pksjce approved these changes Aug 6, 2025

View reviewed changes

pksjce and others added 2 commits August 6, 2025 15:48

Update @primer/react version and deprecate AvatarPair

5b513f6

Deprecate AvatarPair component and move to @primer/react/deprecated

Fix import paths in AvatarPair files after component migration

dc6ee83

Co-authored-by: pksjce <417268+pksjce@users.noreply.github.com>

pksjce marked this pull request as ready for review August 6, 2025 05:48

Copilot AI review requested due to automatic review settings August 6, 2025 05:48

pksjce requested a review from a team as a code owner August 6, 2025 05:48

pksjce requested a review from joshblack August 6, 2025 05:48

github-actions bot temporarily deployed to storybook-preview-6468 August 6, 2025 09:31 Inactive

pksjce approved these changes Aug 6, 2025

View reviewed changes

francinelucca reviewed Aug 7, 2025

View reviewed changes

Copilot started work on behalf of pksjce August 7, 2025 12:47 View session

Copilot AI and others added 2 commits August 7, 2025 12:55

Export AvatarPair from both main and deprecated packages to avoid bre…

f527ee9

…aking change Co-authored-by: pksjce <417268+pksjce@users.noreply.github.com>

Copilot AI changed the title ~~Deprecate AvatarPair component - move to @primer/react/deprecated and remove internal usage~~ Deprecate AvatarPair component - move to @primer/react/deprecated while maintaining backward compatibility Aug 7, 2025

Copilot AI requested a review from pksjce August 7, 2025 13:01

Copilot finished work on behalf of pksjce August 7, 2025 13:01

Copilot AI deployed to github-pages August 7, 2025 22:24 View deployment

github-actions bot temporarily deployed to storybook-preview-6468 August 7, 2025 22:24 Inactive

Copilot started work on behalf of pksjce August 8, 2025 02:44 View session

Update exports test snapshot to include AvatarPair components

ea6c23d

Co-authored-by: pksjce <417268+pksjce@users.noreply.github.com>

Copilot finished work on behalf of pksjce August 8, 2025 02:51

Copilot AI deployed to github-pages August 8, 2025 03:12 View deployment

github-actions bot temporarily deployed to storybook-preview-6468 August 8, 2025 03:12 Inactive

pksjce approved these changes Aug 8, 2025

View reviewed changes

pksjce requested a review from francinelucca August 11, 2025 22:48

francinelucca approved these changes Aug 12, 2025

View reviewed changes

pksjce enabled auto-merge August 12, 2025 02:48

Merge branch 'main' into copilot/fix-725496f0-f8e6-4b27-89f4-f89e53bd…

ab977f5

…5015

pksjce added this pull request to the merge queue Aug 12, 2025

jonrohan deployed to github-pages August 12, 2025 16:41 — with GitHub Actions View deployment

github-actions bot deployed to storybook-preview-6468 August 12, 2025 16:42 View deployment

Merged via the queue into main with commit 1f531cb Aug 12, 2025
39 checks passed

pksjce deleted the copilot/fix-725496f0-f8e6-4b27-89f4-f89e53bd5015 branch August 12, 2025 16:46

primer bot mentioned this pull request Aug 12, 2025

Release tracking (rc) #6589

Merged

		@@ -0,0 +1 @@
		[] No newline at end of file

Conversation

Copilot AI commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes Made

Component Migration

Export Updates

Internal Usage Removal

Deprecation Notices

Migration Path for Users

Validation

Uh oh!

changeset-bot bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Aug 6, 2025

Uh oh!

pksjce commented Aug 6, 2025

Uh oh!

github-actions bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

pksjce commented Aug 6, 2025

Uh oh!

Copilot AI commented Aug 6, 2025

Uh oh!

pksjce Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

pksjce Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Aug 6, 2025

Uh oh!

francinelucca Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

pksjce Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pksjce Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

pksjce commented Aug 8, 2025

Uh oh!

Copilot AI commented Aug 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Aug 6, 2025 •

edited

Loading

changeset-bot bot commented Aug 6, 2025 •

edited

Loading

github-actions bot commented Aug 6, 2025 •

edited

Loading

pksjce Aug 7, 2025 •

edited

Loading