search

helm / helm-www

The Helm website for docs, blog and project info.
https://helm.sh
MIT License
204 stars 515 forks source link

Improve helm lint documentation clarity #1637

Open myk0la-b opened 2 weeks ago

myk0la-b commented 2 weeks ago

Clarified helm lint --with-subcharts option documentation

Please note https://github.com/helm/helm/issues/12027 -- abovementioned unclear part caused many people to struggle

Please help with other languages documentatiton

astellingwerf commented 2 weeks ago

To me, the documentation is still unclear: I don't understand what this option does, especially since the linting behavior is so different from helm template. It seems impossible to lint the subscharts if they use template provided by the superchart.

myk0la-b commented 2 weeks ago

@astellingwerf, so the thing I am trying to emphasize there is that when you run helm lint without the --with-subcharts option, your subchart will be linted as part of the superchart. i.e. it exactly does

lint the subscharts if they use template provided by the superchart

But on the other hand, when the --with-subcharts option is used, the subchart would be additionally linted as an independent entity.