readme-generator-for-helm icon indicating copy to clipboard operation
readme-generator-for-helm copied to clipboard

Feature Request: Support Multiple Values Files

Open yaskinny opened this issue 3 years ago • 1 comments

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.

yaskinny avatar Aug 04 '22 09:08 yaskinny

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.

fmulero avatar Dec 04 '23 10:12 fmulero