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

Improve config option metadata to define where options can be used and improve JSON schema #26571

Open
rarkins opened this issue Jan 10, 2024 · 3 comments
Labels
core:config Related to config capabilities and presets priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:feature Feature (new functionality)

Comments

@rarkins
Copy link
Collaborator

rarkins commented Jan 10, 2024

Describe the proposed change(s).

Enhance this source file: https://github.com/renovatebot/renovate/blob/main/lib/config/options/index.ts

Right now we have some options with "parent" defined (such as packageRules>matchPackageNames) but it's not enough info to generate the JSON schema accurately when options such as enabled can be at root or within packageRules, or options such as configMigration must be at the root of config.

It's even more complicated when you consider that we support some dynamic config options such as minor, or manager names such as gomod.

We should brainstorm about all the possible objects which config can be in (root, hostRules, packageRules, managers, etc) and then define the syntax. Perhaps parent should just be an array instead of single string.

@rarkins rarkins added priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others core:config Related to config capabilities and presets labels Jan 10, 2024
@rarkins
Copy link
Collaborator Author

rarkins commented Jan 10, 2024

Ref: #26484

@viceice
Copy link
Member

viceice commented Jan 11, 2024

as a first step I would suggest to change parent to parents to allow multiple parents.

@rarkins
Copy link
Collaborator Author

rarkins commented Jan 11, 2024

I split off #26599 @RahulGautamSingh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core:config Related to config capabilities and presets priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:feature Feature (new functionality)
Projects
None yet
Development

No branches or pull requests

2 participants