terramate-io / terramate

Terramate CLI is an open-source Infrastructure as Code (IaC) Orchestration and Code Generation tool for Terraform, OpenTofu and Terragrunt.
https://terramate.io
Mozilla Public License 2.0
3.2k stars 88 forks source link

[FEATURE] Create stacks without description #1435

Open cwe1ss opened 6 months ago

cwe1ss commented 6 months ago

Is your feature request related to a problem? Please describe. When using terramate create, the resulting stack.tm.hcl always contains a description that equals the name, even if I set --description="".

We do not need the description field in many cases because the name and directory-path are self-explanatory.

Describe the solution you'd like The description should either not be created at all (like all other optional fields) or there should be a way to omit it via a flag on terramate create.

Describe alternatives you've considered The current workaround is to manually delete the description field and call terramate fmt afterwards (since the indentation needs to change)

i4ki commented 6 months ago

The stack.description is an optional stack field, then I think makes sense supporting not setting it if the user requests to do so. I think --description="" should work as intended or maybe making this flag negatable with --no-description.

@mariux wdyt?