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 helm lint documentation clarity #1637

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

myk0la-b
Copy link

@myk0la-b myk0la-b commented Nov 5, 2024

Clarified helm lint --with-subcharts option documentation

Please note helm/helm#12027 -- abovementioned unclear part caused many people to struggle

Please help with other languages documentatiton

Clarified helm lint --with-subcharts option documentation

Signed-off-by: Mykola <[email protected]>
@astellingwerf
Copy link

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
Copy link
Author

myk0la-b commented Nov 9, 2024

@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.

@@ -35,7 +35,7 @@ helm lint PATH [flags]
--skip-schema-validation if set, disables JSON schema validation
--strict fail on lint warnings
-f, --values strings specify values in a YAML file or a URL (can specify multiple)
--with-subcharts lint dependent charts
--with-subcharts lint subcharts as independent charts (note that without this option, the chart will be validated as a whole, including subcharts as its part)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This document is generated from Helm itself. So are all the files in this directory.

It needs to be changed at https://github.com/helm/helm/blob/ecc4adee692333629dbe6343fbcda58f8643b0ca/cmd/helm/lint.go#L149.

Please update it in the other location.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additionally, the wording is still hazy. Maybe something like this could be better:

Suggested change
--with-subcharts lint subcharts as independent charts (note that without this option, the chart will be validated as a whole, including subcharts as its part)
--with-subcharts lint subcharts separately from the parent chart

To be honest, this option's name is already misleading. But that's much harder to change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants