Set up a values.schema.json pattern
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 46
- Forks
- 40
- Avg merge
- 4h 3m
- Merged PRs (30d)
- 6
Description
The values.schema.json file enables some snazzy ArtifactHub behavior that allows users to explore valid values (on display here)
This is also a part of helm's validation behavior, so can protect users from some invalid values: https://helm.sh/docs/topics/charts/#schema-files
An example that renders the artifacthub behavior above: https://gist.github.com/colearendt/7e5066c92d74df43010e16e3c118938c
- Figure out a way to define JSON schema in a sane way (perhaps related to #17 ). Is there a UI explorer that makes it easy to interact with these types of files? Something that approximates ArtifactHub?
- A way to generate
values.yamlfrom the JSON schema? - Embed the values.schema.json file into the chart, and release it
- Ensure that the display is appropriate on artifacthub
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review Helm's schema-files documentation, the linked ArtifactHub example, and issue #17 to determine how the chart should define values.schema.json. Decide how schema and values.yaml generation should work, then verify the schema is embedded and released with the chart and renders appropriately on ArtifactHub.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm
- Domain
- devops
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100