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

Support library charts #82

Closed
Anticom opened this issue Jan 14, 2021 · 2 comments
Closed

Support library charts #82

Anticom opened this issue Jan 14, 2021 · 2 comments

Comments

@Anticom
Copy link

Anticom commented Jan 14, 2021

Following this guide for library charts there is no value file and no templates that produce yaml directly but only helpers.
It would be nice if helm-docs wasn't skipping the README generation upon missing values file but still render everything from the Chart.yaml meta-data so we get this part documented automatically.

This could either be implemented using a --library-chart etc. flag or as a breaking change where it doesn't skip the generation when the values file is missing.

@mccurdyc
Copy link

mccurdyc commented Jun 9, 2021

@norwoodj Love what helm-docs provides, thank you! if someone were to implement this suport for Helm Library Charts, how would you suggest they do it?

The Helm Library Chart docs explicitly recommend deleting the values.yaml file.

But for helm-docs purposes, we could keep the values.yaml file which would just contain comments and just use the old helm-docs comment format where you explicitly specify field names and accompanying comment.

But, is this really any better than supporting a values.schema.json file? #90

@skang0601
Copy link
Collaborator

Closing in favor of #90, having some spare cycles to start working on support that work.

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

No branches or pull requests

3 participants