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

Draft: support dependency values from Helm Chart archives #207

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

justenstall
Copy link

Working on support for Helm Chart archives (<CHART>-<VERSION>.tgz files) 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 build on the target Chart and helm-docs --document-dependency-values will 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.

Signed-off-by: Justen Stall <justenstall@gmail.com>
Signed-off-by: Justen Stall <justenstall@gmail.com>
Signed-off-by: Justen Stall <justenstall@gmail.com>
…g the archive

Signed-off-by: Justen Stall <justenstall@gmail.com>
Signed-off-by: Justen Stall <justenstall@gmail.com>
@norwoodj
Copy link
Owner

norwoodj commented Jul 6, 2024

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants