bitnami / readme-generator-for-helm

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

Nested complex key values are rendered as the entire parent object when parent key == child key prefix #70

Open ericsnv opened 1 year ago

ericsnv commented 1 year ago

This gets rendered properly:

## @param annotations.vault.hashicorp.com/agent-inject Some desc
annotations:
  vault.hashicorp.com/agent-inject: "true"
Name Description Value
annotations.vault.hashicorp.com/agent-inject Some desc true

This does not:

## @param vault.annotations.vault.hashicorp.com/agent-inject Some desc
vault:
  annotations:
    vault.hashicorp.com/agent-inject: "true"
Name Description Value
vault.annotations.vault.hashicorp.com/agent-inject Some desc {"vault.hashicorp.com/agent-inject":"true"}

Notice that the top-level key is the same as the leaf key's prefix (vault).

The error is likely in this function

fmulero commented 6 months ago

Sorry for my very late response

I've just created an internal task to work on this issue. I hope to come back soon.