Skip to content

Commit 12b5c48

Browse files
ostermanclaude
andcommitted
docs(tfmigrate): remove dead --all flag, clarify --migration path is migration_dir-relative
Follow-up to the preceding fix commit: `migrate list --all` never had any effect (removed from the CLI), and `--migration <path>` needs to be relative to migration_dir, not the component directory, to avoid the double-prefixing bug that commit fixed. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
1 parent 8a2b760 commit 12b5c48

3 files changed

Lines changed: 4 additions & 7 deletions

File tree

website/docs/cli/commands/terraform/terraform-migrate-apply.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Atmos runs the same component preparation as `plan`: auth, source provisioning,
4242
<dd>Identity to authenticate before resolving the component and running `tfmigrate apply`. Environment variable: `ATMOS_IDENTITY`.</dd>
4343

4444
<dt>`--migration`</dt>
45-
<dd>Path to a single `tfmigrate` migration file. Omit this flag to let `tfmigrate` run history mode. Single-file reruns are not inherently idempotent.</dd>
45+
<dd>Path to a single `tfmigrate` migration file, relative to `migration_dir` (defaults to `./migrations` when that directory exists in the component, otherwise the component root) - do not include that prefix. Omit this flag to let `tfmigrate` run history mode. Single-file reruns are not inherently idempotent.</dd>
4646

4747
<dt>`--tfmigrate-config`</dt>
4848
<dd>Override the `tfmigrate` config path. When omitted, `tfmigrate` uses its own default discovery, including `.tfmigrate.hcl`.</dd>

website/docs/cli/commands/terraform/terraform-migrate-list.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,6 @@ atmos terraform migrate list [component] [options]
4545
<dt>`--query`</dt>
4646
<dd>Filter component instances with a YQ expression.</dd>
4747

48-
<dt>`--all`</dt>
49-
<dd>List all component instances in all stacks.</dd>
50-
5148
<dt>`--format` / `-f`</dt>
5249
<dd>Output format. Supported values: `table`, `json`, `yaml`, `csv`, `tsv`.</dd>
5350

@@ -81,10 +78,10 @@ Show history keys for matching components:
8178
atmos terraform migrate list --query '.settings.requires_migration == true' --columns component --columns stack --columns history_key
8279
```
8380

84-
Output JSON for automation:
81+
Output JSON for automation (no `[component]` argument lists every component in every stack):
8582

8683
```shell
87-
atmos terraform migrate list --all --format json
84+
atmos terraform migrate list --format json
8885
```
8986

9087
## Output Columns

website/docs/cli/commands/terraform/terraform-migrate-plan.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ atmos terraform migrate plan [component] -s <stack> [options]
4040
<dd>Identity to authenticate before resolving the component and running `tfmigrate plan`. Environment variable: `ATMOS_IDENTITY`.</dd>
4141

4242
<dt>`--migration`</dt>
43-
<dd>Path to a single `tfmigrate` migration file. Omit this flag to let `tfmigrate` run history mode.</dd>
43+
<dd>Path to a single `tfmigrate` migration file, relative to `migration_dir` (defaults to `./migrations` when that directory exists in the component, otherwise the component root) - do not include that prefix. Omit this flag to let `tfmigrate` run history mode.</dd>
4444

4545
<dt>`--tfmigrate-config`</dt>
4646
<dd>Override the `tfmigrate` config path. When omitted, `tfmigrate` uses its own default discovery, including `.tfmigrate.hcl`.</dd>

0 commit comments

Comments
 (0)