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

Reduce the possibility of an entry in the additional configuration properties metadata accidentally declaring a new property #30076

Closed
wilkinsona opened this issue Mar 6, 2022 · 4 comments
Labels
status: superseded An issue that has been superseded by another type: task A general task

Comments

@wilkinsona
Copy link
Member

It’d be good to reduce the risk of #30074 happening again. Perhaps we could add something to the additional metadata that indicates that an entry should augment an existing property rather than declaring a new property.

#24852 is somewhat similar as it’s also trying to detect a metadata error at build time.

@wilkinsona wilkinsona added the type: enhancement A general enhancement label Mar 6, 2022
@wilkinsona wilkinsona added this to the 2.x milestone Mar 6, 2022
@snicoll
Copy link
Member

snicoll commented Mar 6, 2022

I've been trying to add this but didn't want to introduce a property that would be specific to additional metadata.

@wilkinsona wilkinsona changed the title Reduce the possibility of an entry in the addition configuration properties metadata accidentally declaring a new property Reduce the possibility of an entry in the additional configuration properties metadata accidentally declaring a new property Mar 7, 2022
@SeifMostafa
Copy link

SeifMostafa commented Mar 10, 2022

Is it still available? Need more clarification, Please.

@wilkinsona
Copy link
Member Author

wilkinsona commented Mar 10, 2022

Thanks for asking, @SeifMostafa. We're not yet sure what to do here. Some thinking and design work is required.

If you're looking for an issue that's more suited to someone needing some guidance, please keep an eye out for issues labeled as ideal for contribution and, if you haven't contributed before, first-timers only.

@wilkinsona wilkinsona added the status: pending-design-work Needs design work before any code can be developed label Jul 23, 2022
@wilkinsona
Copy link
Member Author

#31916 has improved things in this area and should prevent problems like #30074 from occurring again. Any property that does not have a description will now fail the build. This will catch stale entries in the additional metadata that only specify a default value.

@wilkinsona wilkinsona removed this from the 2.x milestone Aug 3, 2022
@wilkinsona wilkinsona added status: superseded An issue that has been superseded by another type: task A general task and removed status: pending-design-work Needs design work before any code can be developed type: enhancement A general enhancement labels Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: superseded An issue that has been superseded by another type: task A general task
Projects
None yet
Development

No branches or pull requests

3 participants