-
Notifications
You must be signed in to change notification settings - Fork 551
feat: add values schemas #1752
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
base: develop
Are you sure you want to change the base?
feat: add values schemas #1752
Conversation
👋 @Mokto, could you please review this PR ? Thanks 😄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice. How do we maintain this?
Thanks for the quick review! I initially generated the JSON Schema files using the unmaintained helm-schema-gen plugin, but I’ve now switched to the actively maintained helm-schema plugin. Updated workflow:
I’ll add these steps to the Schema Validation section of the README so contributors can regenerate the schema locally. We could also automate this via a GitHub Action that runs |
That's good enough for me for now ;) But the CI is failing. |
5c149ab
to
8a10398
Compare
Hi @Mokto, @TartanLeGrand and I noticed that many Bitnami charts either lack a I opened an issue to centralize discussion here: bitnami/readme-generator-for-helm#142 To move forward, we have two options:
Which approach do you prefer? |
I would go for option 1 as option 2 might take ages. |
Yes, I agree with you. I'll be working on this option by the end of the week. |
a56c188
to
d4a16a0
Compare
This pull request introduces schema validation for
values.yaml
files in the Sentry Helm charts and includes minor formatting fixes in the documentation. The most important changes are the addition of JSON schema files for validation and updates to the README files to guide users on enabling this feature in supported editors.Schema Validation for Helm Charts
charts/sentry-kubernetes/values.schema.json
) to validatevalues.yaml
files for thesentry-kubernetes
chart.charts/sentry/values.schema.json
) to validatevalues.yaml
files for thesentry
chart.charts/sentry/README.md
for the main Sentry chart, including how to configure editor support.charts/sentry-kubernetes/README.md
for the Sentry Kubernetes chart, including how to configure editor support.Documentation Formatting Fixes
charts/sentry-kubernetes/README.md
andcharts/sentry/README.md
for improved readability. [1] [2]