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

[mdatagen] add deprecation start date and migration instructions #12359

Open
atoulme opened this issue Feb 11, 2025 · 0 comments
Open

[mdatagen] add deprecation start date and migration instructions #12359

atoulme opened this issue Feb 11, 2025 · 0 comments

Comments

@atoulme
Copy link
Contributor

atoulme commented Feb 11, 2025

Component(s)

No response

Describe the issue you're reporting

When setting the status of a component to deprecated, mdatagen should validate the presence of two additional fields in metadata.yaml:

  • One field that contains the date of the deprecation, in format YYYY-MM-DD ("2006-01-02" date parsing format)
  • One field that contains a non empty string with migration instructions. This is a free form field. It is reasonable for someone to enter "No migration is offered for this component", and reviewers of the change can discuss.

Those fields should surface in the README.md generated text.

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

No branches or pull requests

1 participant