Make description optional in chart_schema #372
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`description` is optional: https://helm.sh/docs/topics/charts/#the-chartyaml-file Signed-off-by: Kevin M Granger <[email protected]>
KevinMGranger
force-pushed
the
optional_description
branch
from
2dfdeac to
4a0ff14
Compare
cpanato
approved these changes
Jan 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Makes
descriptionoptional inetc/chart_schema.yaml. It is an optional field per the chart.yaml docs.Without this change, linting will incorrectly report a missing description as a schema error.
Special notes for your reviewer:
There's kind of an open question here: is linting meant to catch errors before they happen, or is it meant to test for best practices? If the former, this PR should be merged. If the latter, it should not be merged, and I think that should be clarified as part of the project's mission in the readme.