Draft: support dependency values from Helm Chart archives #207
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
Signed-off-by: Justen Stall <[email protected]>
Signed-off-by: Justen Stall <[email protected]>
Signed-off-by: Justen Stall <[email protected]>
…g the archive Signed-off-by: Justen Stall <[email protected]>
Signed-off-by: Justen Stall <[email protected]>
|
I think it's a good idea. I'll take a look when you finish |
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.
Working on support for Helm Chart archives (
<CHART>-<VERSION>.tgzfiles) for dependency values.Use case: attempting to use helm-docs in CI pipelines, and the only way I can get it to generate docs for dependency values without vendoring the dependency Charts is by removing the "repository" fields from dependencies. I would like to keep the repository information in Chart.yaml so it is included in the generated README.
With this feature, I can run
helm dependency buildon the target Chart andhelm-docs --document-dependency-valueswill be able to document the values.This could be a stop-gap, it might be better to just find a way to use Helm's own Chart loaders. If the maintainers like this idea but would prefer to use Helm's loader I can set that up instead.