https://www.runatlantis.io/ logo
Join Slack
Powered by
This message was deleted.
# atlantis-contributors
s
This message was deleted.
g
@רועי טבת how are you updating the schema file? I looked into https://github.com/karuppiah7890/helm-schema-gen but the results are different.
u
Hi @Gabriel Martinez ive startted with this tool and also online json schema generator they are very basic and not good i created it manually based on all of the values that are documented in values.yaml
the things that are not found weren’t in the values.yaml and ive also added them for documentation
g
we should make it a process and a ci step, so anyone knows what to do when it fails
regarding docs I suggest using helm-docs https://github.com/norwoodj/helm-docs
u
Sure i’ll do some thinking about that
g
having you update the schema every time doesn’t scale 🙂
u
and also im having a draft pr on unittest which will also test this stuff
🙌 1
The thing is that each contributor that implement new stuff in the chart should add it to the schema as he know what are the supposed values for it and also the description
the thing is that now we have a lot of noise from this
my intention was to make the chart more robust as if user do typos or wrong ident in the values.yaml and the installation pass some of the things are not working
and this feature do let him know that something is wrong
g
right, it’s a good feature, now I think we should educate by adding CI steps that send the user to a README file on what to do when it fails
one for the docs and another for the schema
something like adding CONTRIBUTION_GUIDELINES.md
u
you are right so i’ll add it to the CONTRIBUTION_GUIDELINES.md and im also checking if there is a way to disable the schema validation as an helm feature flag when someone get stuck
im working hard to push the unittests as it will make this things float
🚀 1
and also let us approve more contributions safer
p
Whatever we can do to avoid all the missing parameters the better
Adding unittest is good and as @Gabriel Martinez said, we need to add it on the pipeline
@Gabriel Martinez has been reviewing PRs and contributing to the helm charts quite a lot, so his input is very valuable
❤️ 1
u
Hi @PePe Amengual @Gabriel Martinez thank you for all of your help and guidance! so my thinking here are 1. Unittests will defiantly help. 2. I’ll update the contribution guide. 3. Unfortunately currently there isn’t helm flag to disable helm schema validation https://github.com/helm/helm/issues/10398 4. i can think of a test(custom) that will collect all .Values from the templates and verify with the schema - its very extreme. 5. when building the schema i took very strict way to make sure our users will know in the schema validation step if their done something wrong but we can make the schema less strict
let my know your opinion
g
Looks good. I’m fine with not being able to do 3, we just need something that is able to generate the schema file, the same thing can run on a CI job and do a diff to ensure things are updated.
In the meantime I’ll send a PR to make sure the README is always updated. The logic is the same: ci job to test, and instructions of steps so contributors know when it fails.
👍🏽 1
👍 1
2 Views
Open in Slack
PreviousNext
Powered by