Implement support for deprecating components#316
Merged
Conversation
simu
force-pushed
the
feat/component-deprecation
branch
3 times, most recently
from
0a13c4c to
32a85d8
Compare
simu
force-pushed
the
feat/component-deprecation
branch
from
32a85d8 to
a651988
Compare
This commit introduces a new component parameter `_metadata` which is defined as constant in the component template. When adding the parameter to existing components users are responsible to ensure that they mark the parameter as constant (with the `=` prefix). Further, this commit changes Commodore will print out deprecation notices for all components for which `parameters.<component-name>._metadata.deprecated` is `True`.
simu
force-pushed
the
feat/component-deprecation
branch
from
a651988 to
4839f3b
Compare
This commit changes the previous `deprecation_guide` field in the component metadata with a field `deprecation_notice` which can contain free-form text and is appended verbatim to the component deprecation notice.
ccremer
approved these changes
May 7, 2021
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR introduces a new component parameter
_metadatawhich is defined as constant in the component template. When adding the parameter to existing components users are responsible to ensure that they mark the parameter as constant (with the=prefix).Further, this PR changes Commodore will print out deprecation notices for all components for which
parameters.<component-name>._metadata.deprecatedisTrue.Checklist
bug,enhancement,documentation,change,breaking,dependencyas they show up in the changelog