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

PVC Deprecations and configurable auto-correct #1635

Merged
merged 20 commits into from
Nov 28, 2022

Conversation

mxriverlynn
Copy link
Contributor

@mxriverlynn mxriverlynn commented Nov 23, 2022

⚠️ WORK IN PROGRESS ⚠️

Description

As a first step to improving the deprecation architecture in PVC, this PR moves away from a hard coded hash of what components are deprecated, in favor of a deprecations.yml file.

By providing the deprecation configuration as a yaml file, opportunities are opened for other applications to use this deprecation system. For example, an experimental component in dotcom may be marked as deprecated in favor of an alpha or beta version. Rather than forcing the component to be moved into PVC, a separate yaml file with deprecations can be registered in addition to the built in file.

This also prepares PVC for additional architectural changes with deprecations. This will include the addition of a "guide" setting for deprecations, to ensure developers using PVC have the information they need for migrating components that are not auto-correctable.

Changes

  • created lib/deprecations/deprecations.yml to replace the hard coded list of deprecations
  • test the basics of the yml configuration
  • test to ensure all components with status: :deprecated are represented in deprecations.yml
  • added script/build-assets to the script/setup file, to ensure test can be run immediately after setup
  • updated all the code that relies on the deprecations
  • edited popover.pcss to remove & from commented, preventing test failures

Integration

Does this change require any updates to code in production?

none

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Added/updated previews

@changeset-bot
Copy link

changeset-bot bot commented Nov 23, 2022

🦋 Changeset detected

Latest commit: 384d3dd

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

This PR includes changesets to release 1 package
Name Type
@primer/view-components Patch

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

@mxriverlynn mxriverlynn temporarily deployed to review-pr-1635 November 23, 2022 22:07 Inactive
@mxriverlynn mxriverlynn temporarily deployed to github-pages November 23, 2022 22:13 Inactive
@mxriverlynn mxriverlynn temporarily deployed to review-pr-1635 November 25, 2022 15:00 Inactive
@mxriverlynn mxriverlynn temporarily deployed to github-pages November 25, 2022 15:04 Inactive
@mxriverlynn mxriverlynn temporarily deployed to review-pr-1635 November 25, 2022 15:17 Inactive
@mxriverlynn mxriverlynn temporarily deployed to github-pages November 25, 2022 15:22 Inactive
@github-actions github-actions bot added the ruby Pull requests that update Ruby code label Nov 25, 2022
@mxriverlynn mxriverlynn temporarily deployed to github-pages November 25, 2022 15:46 Inactive
@mxriverlynn mxriverlynn temporarily deployed to review-pr-1635 November 25, 2022 15:51 Inactive
@mxriverlynn mxriverlynn temporarily deployed to github-pages November 25, 2022 15:56 Inactive
@mxriverlynn mxriverlynn temporarily deployed to github-pages November 25, 2022 17:32 Inactive
@mxriverlynn mxriverlynn temporarily deployed to github-pages November 25, 2022 17:32 Inactive
@mxriverlynn mxriverlynn marked this pull request as ready for review November 25, 2022 17:33
@mxriverlynn mxriverlynn requested a review from a team as a code owner November 25, 2022 17:33
@mxriverlynn mxriverlynn requested review from a team and jonrohan November 25, 2022 17:33
@mxriverlynn mxriverlynn changed the title [WIP] PVC Deprecations and configurable auto-correct PVC Deprecations and configurable auto-correct Nov 28, 2022
@mxriverlynn mxriverlynn temporarily deployed to github-pages November 28, 2022 18:14 Inactive
script/setup Outdated Show resolved Hide resolved
@mxriverlynn mxriverlynn enabled auto-merge (squash) November 28, 2022 19:21
@mxriverlynn mxriverlynn merged commit 653ac92 into main Nov 28, 2022
@mxriverlynn mxriverlynn deleted the mxriverlynn/autocorrectable branch November 28, 2022 19:23
@primer-css primer-css mentioned this pull request Nov 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
css Pull requests that update CSS code ruby Pull requests that update Ruby code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants