fix: Adjusting strict control docs

[yhakbar]

Description

Fixes #000.

TODOs

Read the Gruntwork contribution guidelines.

• Update the docs.
• Run the relevant tests successfully, including pre-commit checks.
• Ensure any 3rd party code adheres with our license policy or delete this line if its not applicable.
• Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Added / Removed / Updated [X].

Migration Guide

[levkohimins]

info strict deprecated-commands

   Default commands:
   console    replaced with: terragrunt run -- console
   env        replaced with: terragrunt run -- env
   fmt        replaced with: terragrunt run -- fmt
   get        replaced with: terragrunt run -- get
   graph      replaced with: terragrunt run -- graph
   login      replaced with: terragrunt run -- login
   logout     replaced with: terragrunt run -- logout
   metadata   replaced with: terragrunt run -- metadata
   providers  replaced with: terragrunt run -- providers
   push       replaced with: terragrunt run -- push
   taint      replaced with: terragrunt run -- taint
   untaint    replaced with: terragrunt run -- untaint
   version    replaced with: terragrunt run -- version
   workspace  replaced with: terragrunt run -- workspace

   `*-all` commands:
   apply-all     replaced with: terragrunt run-all apply
   destroy-all   replaced with: terragrunt run-all destroy
   output-all    replaced with: terragrunt run-all output
   plan-all      replaced with: terragrunt run-all plan
   spin-up       replaced with: terragrunt run-all apply
   tear-down     replaced with: terragrunt run-all destroy
   validate-all  replaced with: terragrunt run-all validate

info strict legacy-all

   `*-all` commands:
   apply-all     replaced with: terragrunt run-all apply
   destroy-all   replaced with: terragrunt run-all destroy
   output-all    replaced with: terragrunt run-all output
   plan-all      replaced with: terragrunt run-all plan
   spin-up       replaced with: terragrunt run-all apply
   tear-down     replaced with: terragrunt run-all destroy
   validate-all  replaced with: terragrunt run-all validate

info strict default-command

   Default commands:
   console    replaced with: terragrunt run -- console
   env        replaced with: terragrunt run -- env
   fmt        replaced with: terragrunt run -- fmt
   get        replaced with: terragrunt run -- get
   graph      replaced with: terragrunt run -- graph
   login      replaced with: terragrunt run -- login
   logout     replaced with: terragrunt run -- logout
   metadata   replaced with: terragrunt run -- metadata
   providers  replaced with: terragrunt run -- providers
   push       replaced with: terragrunt run -- push
   taint      replaced with: terragrunt run -- taint
   untaint    replaced with: terragrunt run -- untaint
   version    replaced with: terragrunt run -- version
   workspace  replaced with: terragrunt run -- workspace

I don't see the point in users to specify the old *-all commands separately, one by one in the -struct-cotnrol, and I don't see the point in indicating this in the documentation, although I will implement it so that it works, for backward compatibility but I don't see the point in overloading users' brains with these commands, instead we need to give an example of using -strict-control default-command, -strict-control legacy-all ... and indicate which commands/flags are included in each group, what info strict legacy-all, info strict default-command info strict cli-restructure ... output, copy/past. Or, in order not to bloat the documentation, suggest that the user run it and see for themselves what they include.

In this docs we give example to use the old run-all separately, but in the same time we show the deprecated "Default commands" as one default-command control, this is not consistent. In such cases, we need to provide the ability to enable strict control for each default command separately as well.

-struct-cotnrol fmt
-struct-cotnrol get
....

then as well for cli restructure commands:

-strict-control terragrunt-info
-strict-control hclfmt
....

and so on, then mention them in this list as well

Suggested change

	- [plan-all](#plan-all)
	- [apply-all](#apply-all)
	- [destroy-all](#destroy-all)
	- [output-all](#output-all)
	- [validate-all](#validate-all)
	- [spin-up](#spin-up)
	- [tear-down](#tear-down)
	- [default-command](#default-command)
	- [plan-all](#plan-all)
	- [apply-all](#apply-all)
	- [destroy-all](#destroy-all)
	- [output-all](#output-all)
	- [validate-all](#validate-all)
	- [spin-up](#spin-up)
	- [tear-down](#tear-down)
	- [console](#console)
	- [env](#env)
	- [fmt](#fmt)
	- [get](#get)
	- [graph](#graph)
	...

But I wouldn't do that. If I were the user, I would only use:
-strict-control default-command
-strict-control legacy-all
-strict-control cli-restructure

or if I wanted to enable strict for all deprecated commands -strict-control deprecated-commands, but never -strict-control plan-all,-strict-control terragrunt-info ...

[levkohimins]

What is the point of the user uses this

terragrunt plan-all --strict-control plan-all

to enable strict control for the plan-all command, and then to intentionally specify the plan-all command itself. At the same time, knowing that he will 100% get an error.
In my understanding, strict control should help the user from unintentionally using deprecated commands and flags.

That's why it makes more sense to use this command

terragrunt plan-all --strict-control legacy-all

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
terragrunt-docs	❌ Failed (Inspect)			Feb 5, 2025 5:56pm