Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate utility components #1316

Merged
merged 40 commits into from
Jul 22, 2021
Merged

Conversation

VanAnderson
Copy link
Contributor

@VanAnderson VanAnderson commented Jun 22, 2021

Deprecate Utility Components in favor of Box.

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

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

@changeset-bot
Copy link

changeset-bot bot commented Jun 22, 2021

🦋 Changeset detected

Latest commit: 1965269

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/components 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

@vercel
Copy link

vercel bot commented Jun 22, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/primer/primer-components/ApXwFqbohTKh7yDJKffaW8xLef4z
✅ Preview: https://primer-components-git-vananderson-deprecate-utili-211d7d-primer.vercel.app

@vercel vercel bot temporarily deployed to Preview June 22, 2021 21:53 Inactive
@vercel vercel bot temporarily deployed to Preview June 28, 2021 18:37 Inactive
@VanAnderson VanAnderson changed the base branch from main to VanAnderson/add-box-props June 28, 2021 18:44
@vercel vercel bot temporarily deployed to Preview June 30, 2021 15:53 Inactive
@VanAnderson VanAnderson marked this pull request as ready for review June 30, 2021 15:53
Copy link
Contributor

@colebemis colebemis left a comment

Choose a reason for hiding this comment

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

Excellent work, @VanAnderson! Thanks for going above and beyond by writing a codemod for these changes.

This looks good to go. But let's wait to merge this until #1315 is merged.

`
import {Box} from '@primer/components'
export default () => (
<Box display="flex">
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we test that other props are preserved? Example:

- <Flex flexDirection="column">
+ <Box display="flex" flexDirection="column">

"@primer/components": minor
---

Deprecate utility components.
Copy link
Contributor

Choose a reason for hiding this comment

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

It might be helpful for consumers if we listed all the deprecated components explicitly here.

Copy link
Contributor

Choose a reason for hiding this comment

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

In addition to a list of deprecated components, let's also include instructions on how to run the codemod here.

src/Grid.tsx Outdated Show resolved Hide resolved
Co-authored-by: Cole Bemis <colebemis@github.com>
@vercel vercel bot temporarily deployed to Preview July 21, 2021 20:26 Inactive
@vercel vercel bot temporarily deployed to Preview July 21, 2021 20:46 Inactive
@vercel vercel bot temporarily deployed to Preview July 21, 2021 20:54 Inactive
src/Position.tsx Outdated Show resolved Hide resolved
Co-authored-by: Cole Bemis <colebemis@github.com>
@vercel vercel bot temporarily deployed to Preview July 22, 2021 15:46 Inactive
VanAnderson and others added 2 commits July 22, 2021 10:46
Co-authored-by: Cole Bemis <colebemis@github.com>
Co-authored-by: Cole Bemis <colebemis@github.com>
@vercel vercel bot temporarily deployed to Preview July 22, 2021 15:49 Inactive
@vercel vercel bot temporarily deployed to Preview July 22, 2021 17:32 Inactive
@vercel vercel bot temporarily deployed to Preview July 22, 2021 18:25 Inactive
@vercel vercel bot temporarily deployed to Preview July 22, 2021 18:37 Inactive
@vercel vercel bot temporarily deployed to Preview July 22, 2021 18:42 Inactive
@vercel vercel bot temporarily deployed to Preview July 22, 2021 18:53 Inactive
@colebemis colebemis merged commit 4c06331 into main Jul 22, 2021
@colebemis colebemis deleted the VanAnderson/deprecate-utility-components branch July 22, 2021 19:01
@github-actions github-actions bot mentioned this pull request Jul 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants