Skip to content

helm-tool inject sometimes omits the context (prefix) of commented out values in the generated markdown #25

@wallrj

Description

@wallrj

In cert-manager/approver-policy#383 I originally added a new block to the end of the existing values.yaml file:

> podDisruptionBudget:
>   # Enable or disable the PodDisruptionBudget resource.
>   #
>   # This prevents downtime during voluntary disruptions such as during a Node upgrade.
>   # For example, the PodDisruptionBudget blocks `kubectl drain`
>   # if it is used on the Node where the only remaining approver-policy
>   # Pod is currently running.
>   enabled: false
> 
>   # Configures the minimum available pods for disruptions.
>   # Cannot be used if `maxUnavailable` is set.
>   # +docs:property
>   # minAvailable: 1
> 
>   # Configures the maximum unavailable pods for disruptions.
>   # Cannot be used if `minAvailable` is set.
>   # +docs:property
>   # maxUnavailable: 1
> 

But when I ran make generate-helm-docs it added minAvailable and maxUnavailable as global values, rather than prefixed like podDisruptionBudget.minAvailable .

It seemed to only be a problem when the commented out values were the last in the file.
Adding a trailing foo: bar or moving the new block above some other existing blocks fixed the problem.

/kind bug

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/bugCategorizes issue or PR as related to a bug.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions