Skip to content

Commit 600f176

Browse files
authored
fix: Avoiding duplicate description in flag names (#4092)
1 parent 29da1c4 commit 600f176

5 files changed

Lines changed: 14 additions & 9 deletions

File tree

docs-starlight/src/data/flags/backend-require-bootstrap.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
22
name: backend-require-bootstrap
3-
description: When this flag is set Terragrunt will fail if the remote state bucket needs to be created.
3+
description: |
4+
When this flag is set, Terragrunt will throw an error if remote state needs to be created via the `backend bootstrap` command.
45
type: bool
56
env:
67
- TG_BACKEND_REQUIRE_BOOTSTRAP
78
---
89

9-
This flag provides a safety mechanism when working with remote state backends. When enabled, Terragrunt will fail with an error if it detects that the remote state bucket does not exist and would need to be created.
10+
This flag provides a safety mechanism when working with remote state backends.
1011

1112
This is particularly useful in production environments where you want to ensure that:
1213

docs-starlight/src/data/flags/dependency-fetch-output-from-state.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
name: dependency-fetch-output-from-state
3-
description: The option fetches dependency output directly from the state file instead of using tofu/terraform output.
3+
description: |
4+
Fetch dependency outputs directly from the state file instead of using `tofu output`.
45
type: bool
56
env:
67
- TG_DEPENDENCY_FETCH_OUTPUT_FROM_STATE

docs-starlight/src/data/flags/disable-bucket-update.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
22
name: disable-bucket-update
3-
description: When this flag is set Terragrunt will not update the remote state bucket.
3+
description: |
4+
When this flag is set, Terragrunt will not update the remote state resources.
45
type: bool
56
env:
67
- TG_DISABLE_BUCKET_UPDATE
78
---
89

9-
This flag prevents Terragrunt from making any modifications to the remote state bucket configuration. When enabled, Terragrunt will fail if it detects that the remote state bucket needs to be updated.
10+
When enabled, Terragrunt will throw an error if it detects that remote state resources need to be updated.
1011

1112
This is useful in scenarios where:
1213
- You want to ensure state bucket configurations remain unchanged during operations
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
22
name: log-format
3-
description: Set the log format.
3+
description: |
4+
Set the format for Terragrunt's log output.
45
type: string
56
env:
67
- TG_LOG_FORMAT
78
---
89

9-
Sets the format for Terragrunt's log output. For a list of available formats and their descriptions, see the [log formatting documentation](/docs/reference/logging/formatting).
10+
For a list of available formats and their descriptions, see the [log formatting documentation](/docs/reference/logging/formatting).

docs-starlight/src/data/flags/no-destroy-dependencies-check.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
22
name: no-destroy-dependencies-check
3-
description: When this flag is set, Terragrunt will not check for dependent units when destroying.
3+
description: |
4+
Disables Terragrunt's dependency validation during destroy operations.
45
type: bool
56
env:
67
- TG_NO_DESTROY_DEPENDENCIES_CHECK
78
---
89

910
import { Aside } from '@astrojs/starlight/components';
1011

11-
Disables Terragrunt's dependency validation during destroy operations. When enabled, Terragrunt will not verify if there are dependent units that would be affected by destroying the current unit.
12+
When enabled, Terragrunt will not verify if there are dependent units that would be affected by destroying the current unit.
1213

1314
This results in faster destroy operations, but may result in orphaned resources.
1415

0 commit comments

Comments
 (0)