-
Notifications
You must be signed in to change notification settings - Fork 113
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 384d3dd The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
…orrected component test
…d in deprecations.yml
… that looks for it without context
mxriverlynn
changed the title
[WIP] PVC Deprecations and configurable auto-correct
PVC Deprecations and configurable auto-correct
Nov 28, 2022
jonrohan
reviewed
Nov 28, 2022
jonrohan
approved these changes
Nov 28, 2022
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
lib/deprecations/deprecations.yml
to replace the hard coded list of deprecationsstatus: :deprecated
are represented indeprecations.yml
script/build-assets
to thescript/setup
file, to ensure test can be run immediately after setup&
from commented, preventing test failuresIntegration
none
Merge checklist