search

bitnami / readme-generator-for-helm

Auto generate READMEs for Helm Charts
https://bitnami.com
Apache License 2.0
222 stars 48 forks source link

Add support for non-empty array default values in the Readme #6

Closed migruiz4 closed 3 years ago

migruiz4 commented 3 years ago

Related to https://github.com/bitnami/charts/pull/7007.

The Readme-generator does not have support to include in the README the Arrays default values when needed. For example, the field master.disableCommands in the Redis chart, appears with default value [], when it should be [FLUSHDB, FLUSHALL].

I consider this information not trivial, and therefore should be included in the Readme generator.

As a suggestion, we could add a flag similar to @skip or [array], that replaced the default value with a message recommending to Check the values.yaml when the array is too big to be displayed in the Readme table.

miguelaeh commented 3 years ago

I agree the arrays should not be set as empty by default. This was a change to avoid adding too long data as the default value.