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

Use https://github.com/norwoodj/helm-docs to generate VALUES_SUMMARY.md #986

Closed
kvanzuijlen opened this issue Jan 30, 2024 · 2 comments · Fixed by #1038
Closed
Labels
enhancement New feature or request

Comments

@kvanzuijlen
Copy link
Contributor

kvanzuijlen commented Jan 30, 2024

Is your feature request related to a problem? Please describe

I'd like to propose/implement https://github.com/norwoodj/helm-docs to automatically generate a summary of the configurable values, similar to https://github.com/renovatebot/helm-charts/tree/main/charts/renovate#values. This could be part of the README.md in charts/jenkins or (still) a separate file, your preference. Using helm-docs would mean copying the current documentation to the values.yaml file.

@kvanzuijlen kvanzuijlen added the enhancement New feature or request label Jan 30, 2024
@timja
Copy link
Member

timja commented Jan 30, 2024

Sounds great, happy either way depending on what it looks like

@kvanzuijlen
Copy link
Contributor Author

I'll get a PR going once I'm done with #979 unless someone else wants to pick this up in the meantime!

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

Successfully merging a pull request may close this issue.

2 participants