Skip to content

Commit f995a6c

Browse files
yhakbaryhakbar
committed
docs: Updating migration guide for --terragrunt- flag removal
1 parent 0209de0 commit f995a6c

File tree

2 files changed

+118
-0
lines changed

2 files changed

+118
-0
lines changed

‎docs-starlight/src/content/docs/06-migrate/03-cli-redesign.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,65 @@ terragrunt plan --inputs-debug
6161

6262
You can find the new flag names in the [CLI reference](/docs/reference/cli/) (including the deprecated flags they replace).
6363

64+
### CLI Flag Migration Table
65+
66+
Below is a comprehensive mapping of old CLI flag names to their modern counterparts:
67+
68+
| Old Flag | New Flag |
69+
|----------|----------|
70+
| `--terragrunt-config` | `--config` |
71+
| `--terragrunt-working-dir` | `--working-dir` |
72+
| `--terragrunt-download-dir` | `--download-dir` |
73+
| `--terragrunt-source` | `--source` |
74+
| `--terragrunt-source-map` | `--source-map` |
75+
| `--terragrunt-source-update` | `--source-update` |
76+
| `--terragrunt-iam-role` | `--iam-assume-role` |
77+
| `--terragrunt-iam-assume-role-duration` | `--iam-assume-role-duration` |
78+
| `--terragrunt-iam-web-identity-token` | `--iam-assume-role-web-identity-token` |
79+
| `--terragrunt-ignore-dependency-errors` | `--queue-ignore-errors` |
80+
| `--terragrunt-excludes-file` | `--queue-excludes-file` |
81+
| `--terragrunt-exclude-dir` | `--queue-exclude-dir` |
82+
| `--terragrunt-include-dir` | `--queue-include-dir` |
83+
| `--terragrunt-strict-include` | `--queue-strict-include` |
84+
| `--terragrunt-ignore-dependency-order` | `--queue-ignore-dag-order` |
85+
| `--terragrunt-ignore-external-dependencies` | `--queue-exclude-external` |
86+
| `--terragrunt-include-external-dependencies` | `--queue-include-external` |
87+
| `--terragrunt-strict-validate` | `--strict-validate` |
88+
| `--terragrunt-parallelism` | `--parallelism` |
89+
| `--terragrunt-debug` | `--inputs-debug` |
90+
| `--terragrunt-log-level` | `--log-level` |
91+
| `--terragrunt-log-format` | `--log-format` |
92+
| `--terragrunt-log-custom-format` | `--log-custom-format` |
93+
| `--terragrunt-log-disable` | `--log-disable` |
94+
| `--terragrunt-log-show-abs-paths` | `--log-show-abs-paths` |
95+
| `--terragrunt-no-color` | `--no-color` |
96+
| `--terragrunt-check` | `--check` |
97+
| `--terragrunt-diff` | `--diff` |
98+
| `--terragrunt-hclfmt-file` | `--file` |
99+
| `--terragrunt-hclfmt-exclude-dir` | `--exclude-dir` |
100+
| `--terragrunt-hclfmt-stdin` | `--stdin` |
101+
| `--terragrunt-hclvalidate-json` | `--json` |
102+
| `--terragrunt-hclvalidate-show-config-path` | `--show-config-path` |
103+
| `--terragrunt-json-disable-dependent-modules` | `--disable-dependent-modules` |
104+
| `--terragrunt-json-out` | `--out` |
105+
| `--terragrunt-modules-that-include` | `--units-that-include` |
106+
| `--terragrunt-queue-include-units-reading` | `--queue-include-units-reading` |
107+
| `--terragrunt-fetch-dependency-output-from-state` | `--dependency-fetch-output-from-state` |
108+
| `--terragrunt-use-partial-parse-config-cache` | `--use-partial-parse-config-cache` |
109+
| `--terragrunt-fail-on-state-bucket-creation` | `--backend-require-bootstrap` |
110+
| `--terragrunt-disable-bucket-update` | `--disable-bucket-update` |
111+
| `--terragrunt-disable-command-validation` | `--disable-command-validation` |
112+
| `--terragrunt-provider-cache` | `--provider-cache` |
113+
| `--terragrunt-provider-cache-dir` | `--provider-cache-dir` |
114+
| `--terragrunt-provider-cache-hostname` | `--provider-cache-hostname` |
115+
| `--terragrunt-provider-cache-port` | `--provider-cache-port` |
116+
| `--terragrunt-provider-cache-token` | `--provider-cache-token` |
117+
| `--terragrunt-provider-cache-registry-names` | `--provider-cache-registry-names` |
118+
| `--terragrunt-out-dir` | `--out-dir` |
119+
| `--terragrunt-json-out-dir` | `--json-out-dir` |
120+
| `--terragrunt-forward-tf-stdout` | `--tf-forward-stdout` |
121+
| `--terragrunt-no-destroy-dependencies-check` | `--no-destroy-dependencies-check` |
122+
64123
### Update environment variables
65124

66125
If you are currently using environment variables to configure Terragrunt, you will need to stop using that environment variable, and use a differently named one instead (usually the same exact environment variable with `TERRAGRUNT_` replaced with `TG_`, but not always).

‎docs/_docs/06_migration_guides/03-cli-redesign.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,65 @@ terragrunt plan --inputs-debug
6666

6767
You can find the new flag names in the [CLI reference](/docs/reference/cli/) (including the deprecated flags they replace).
6868

69+
### CLI Flag Migration Table
70+
71+
Below is a comprehensive mapping of old CLI flag names to their modern counterparts:
72+
73+
| Old Flag | New Flag |
74+
|----------|----------|
75+
| `--terragrunt-config` | `--config` |
76+
| `--terragrunt-working-dir` | `--working-dir` |
77+
| `--terragrunt-download-dir` | `--download-dir` |
78+
| `--terragrunt-source` | `--source` |
79+
| `--terragrunt-source-map` | `--source-map` |
80+
| `--terragrunt-source-update` | `--source-update` |
81+
| `--terragrunt-iam-role` | `--iam-assume-role` |
82+
| `--terragrunt-iam-assume-role-duration` | `--iam-assume-role-duration` |
83+
| `--terragrunt-iam-web-identity-token` | `--iam-assume-role-web-identity-token` |
84+
| `--terragrunt-ignore-dependency-errors` | `--queue-ignore-errors` |
85+
| `--terragrunt-excludes-file` | `--queue-excludes-file` |
86+
| `--terragrunt-exclude-dir` | `--queue-exclude-dir` |
87+
| `--terragrunt-include-dir` | `--queue-include-dir` |
88+
| `--terragrunt-strict-include` | `--queue-strict-include` |
89+
| `--terragrunt-ignore-dependency-order` | `--queue-ignore-dag-order` |
90+
| `--terragrunt-ignore-external-dependencies` | `--queue-exclude-external` |
91+
| `--terragrunt-include-external-dependencies` | `--queue-include-external` |
92+
| `--terragrunt-strict-validate` | `--strict-validate` |
93+
| `--terragrunt-parallelism` | `--parallelism` |
94+
| `--terragrunt-debug` | `--inputs-debug` |
95+
| `--terragrunt-log-level` | `--log-level` |
96+
| `--terragrunt-log-format` | `--log-format` |
97+
| `--terragrunt-log-custom-format` | `--log-custom-format` |
98+
| `--terragrunt-log-disable` | `--log-disable` |
99+
| `--terragrunt-log-show-abs-paths` | `--log-show-abs-paths` |
100+
| `--terragrunt-no-color` | `--no-color` |
101+
| `--terragrunt-check` | `--check` |
102+
| `--terragrunt-diff` | `--diff` |
103+
| `--terragrunt-hclfmt-file` | `--file` |
104+
| `--terragrunt-hclfmt-exclude-dir` | `--exclude-dir` |
105+
| `--terragrunt-hclfmt-stdin` | `--stdin` |
106+
| `--terragrunt-hclvalidate-json` | `--json` |
107+
| `--terragrunt-hclvalidate-show-config-path` | `--show-config-path` |
108+
| `--terragrunt-json-disable-dependent-modules` | `--disable-dependent-modules` |
109+
| `--terragrunt-json-out` | `--out` |
110+
| `--terragrunt-modules-that-include` | `--units-that-include` |
111+
| `--terragrunt-queue-include-units-reading` | `--queue-include-units-reading` |
112+
| `--terragrunt-fetch-dependency-output-from-state` | `--dependency-fetch-output-from-state` |
113+
| `--terragrunt-use-partial-parse-config-cache` | `--use-partial-parse-config-cache` |
114+
| `--terragrunt-fail-on-state-bucket-creation` | `--backend-require-bootstrap` |
115+
| `--terragrunt-disable-bucket-update` | `--disable-bucket-update` |
116+
| `--terragrunt-disable-command-validation` | `--disable-command-validation` |
117+
| `--terragrunt-provider-cache` | `--provider-cache` |
118+
| `--terragrunt-provider-cache-dir` | `--provider-cache-dir` |
119+
| `--terragrunt-provider-cache-hostname` | `--provider-cache-hostname` |
120+
| `--terragrunt-provider-cache-port` | `--provider-cache-port` |
121+
| `--terragrunt-provider-cache-token` | `--provider-cache-token` |
122+
| `--terragrunt-provider-cache-registry-names` | `--provider-cache-registry-names` |
123+
| `--terragrunt-out-dir` | `--out-dir` |
124+
| `--terragrunt-json-out-dir` | `--json-out-dir` |
125+
| `--terragrunt-forward-tf-stdout` | `--tf-forward-stdout` |
126+
| `--terragrunt-no-destroy-dependencies-check` | `--no-destroy-dependencies-check` |
127+
69128
### Update environment variables
70129

71130
If you are currently using environment variables to configure Terragrunt, you will need to stop using that environment variable, and use a differently named one instead (usually the same exact environment variable with `TERRAGRUNT_` replaced with `TG_`, but not always).

0 commit comments

Comments
 (0)