Skip to content

[FEATURE] Option for not rendering "tmdoc"-comments in bundle instances #2303

@cwe1ss

Description

@cwe1ss

Is your feature request related to a problem? Please describe.
When creating a bundle instance using terramate ui, the resulting tm.yml-files contain # tmdoc: -prefixed comments with the input's description above every input. This is a problem for us, because whenever we change the description, these comments are out of date.

Describe the solution you'd like
Please either do not render tmdoc-lines at all (I think they are not useful since at some point, they will be out of date anyway), or provide a flag in the terramate-config block of the root terramate.tm.hcl to disable this feature for the repo.

Describe alternatives you've considered
To get actual up-to-date docs on hover in VS Code, we auto-generate a JSON schema for every bundle and use it with the Red Hat YAML extension.

Additional context
Terramate version: v0.17.0-rc2

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions