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

Feature Request: Support Multiple Values Files #49

Closed
yaskinny opened this issue Aug 4, 2022 · 1 comment
Closed

Feature Request: Support Multiple Values Files #49

yaskinny opened this issue Aug 4, 2022 · 1 comment
Assignees

Comments

@yaskinny
Copy link

yaskinny commented Aug 4, 2022

Hello!
Is it possible to pass multiple values files?
for instance if I have a chart with multiple values files for different environments, is there a way to use readme-generator to add all of them into my README?

an example:
values.prod.yaml:

## @section general
## @param user username for app
user: this

## @section production
## @param ca_type ca type
ca_type: acme

values.staging.yaml:

## @section general
## @param user username for app
user: this

## @section staging
## @param tls_provider ca type
ca_type: self_signed

If its not already possible, it would be very useful if You can add it. I'm using this tool for other stuff too like Ansible roles: defaults/main.yaml and vars/main.yaml. I believe this feature will add more use cases to this tool.

@fmulero
Copy link
Contributor

fmulero commented Dec 4, 2023

Hi @yaskinny, sorry for my very late response.

Using different values files is not possible right now and to be honest I am not sure how does it fit. Should all files use the same parameters section? What should be the behaviour if we have the same param with different content for the same section in different files?

I think running readme-generator several times with different config files (to set the paramsSectionTitle for each file) could fit your particular needs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants