Commit be30ca7
docs(cli):
* docs(cli): `os migrate meta --from` lists the edits, it does not rewrite (#10831)
Four hand-written docs-site pages and one docblock inside the command's own
source told authors that `os migrate meta --from N` rewrites their files. It
rewrites none. The `--from` arm replays the ADR-0087 chain over the loaded
stack in memory and reports the diff; both `writeFileSync` calls in
`packages/cli/src/commands/migrate/meta.ts` are guarded by `if (flags.out)`,
so the only file it ever writes is the `--out` JSON snapshot, and the command
header at :155-157 explicitly declines the AST rewrite as "unsafe and lossy".
The in-place codemod is separate and unbuilt.
Two of the four were wrong twice over: they attached a *stored*-arm behaviour
("stored flows are rewritten", "rewrite stored metadata automatically") to
`--from`, which is declared `exclusive: ['stored']` at :195-198 and therefore
cannot be combined with `--stored` at all. Both errors are fixed, not just the
verb, and "automatically" — the word the class-wide reword existed to remove —
is gone.
All four now carry the already-blessed sentence the generated reference
carriers use: run the command to LIST the mechanical edits for existing
sources, then apply them by hand.
The `pendingDataMigrations` docblock at :81 rides along per triage: the
contrast it draws (metadata migration's subject is the author's source, the
data migrations' subject is a deployment's rows) is correct and is preserved;
only the false verb on the first half changed.
Split on the ARM, not on the verb: `os migrate meta --stored --apply` genuinely
does rewrite `sys_metadata` rows, so no `--stored` wording was touched anywhere,
and `content/docs/releases/**` was not edited.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DdCnBGcHeufjrq7drTD3wt
* docs(deployment): the `--from` half of cli.mdx's division-of-labour sentence lists, it does not rewrite
`content/docs/deployment/cli.mdx:921-924` is a fifth carrier of the same false
verb this PR exists to remove, and the card's table did not reach it:
`os migrate meta --from N` rewrites an **author's source** and reads no
database; `--stored` rewrites **one deployment's rows** and reads no config.
The `--from` half is false for the same reason as the other four — the arm
replays the chain in memory and prints the mechanical edits; both `writeFileSync`
calls in `packages/cli/src/commands/migrate/meta.ts` are guarded by
`if (flags.out)`, so the only file it writes is the `--out` JSON snapshot.
This is the same source-vs-rows contrast shape as the `meta.ts:81` docblock, so
it gets the same treatment triage ruled for that one: the contrast is correct and
is preserved verbatim — both bold subjects, "reads no database" / "reads no
config", and the mutual-exclusion note (which restates `exclusive: ['stored']`)
are untouched. Only the verb on the `--from` half changed.
Split on the ARM, not on the verb: the `--stored` half of this very sentence is
correct and is left exactly as it was, as are every other `--stored` mention on
the page (:624, :679, :850, :864-867). Line :838 already said "reports what is
left to do" and needed nothing.
Committed separately from the four dispatched pages so it can be dropped on its
own if review judges it out of scope.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DdCnBGcHeufjrq7drTD3wt
---------
Co-authored-by: Claude <noreply@anthropic.com>os migrate meta --from lists the mechanical edits, it does not rewrite your sources (#10847)1 parent 7d483e1 commit be30ca7
6 files changed
Lines changed: 39 additions & 14 deletions
File tree
- .changeset
- content/docs
- automation
- data-modeling
- deployment
- protocol/objectql
- packages/cli/src/commands/migrate
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
242 | 242 | | |
243 | 243 | | |
244 | 244 | | |
245 | | - | |
246 | | - | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
247 | 248 | | |
248 | 249 | | |
249 | 250 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
385 | 385 | | |
386 | 386 | | |
387 | 387 | | |
388 | | - | |
389 | | - | |
| 388 | + | |
| 389 | + | |
390 | 390 | | |
391 | 391 | | |
392 | 392 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
919 | 919 | | |
920 | 920 | | |
921 | 921 | | |
922 | | - | |
923 | | - | |
924 | | - | |
| 922 | + | |
| 923 | + | |
| 924 | + | |
925 | 925 | | |
926 | 926 | | |
927 | 927 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
857 | 857 | | |
858 | 858 | | |
859 | 859 | | |
860 | | - | |
| 860 | + | |
| 861 | + | |
861 | 862 | | |
862 | 863 | | |
863 | 864 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
78 | 78 | | |
79 | 79 | | |
80 | 80 | | |
81 | | - | |
82 | | - | |
83 | | - | |
84 | | - | |
85 | | - | |
86 | | - | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
87 | 87 | | |
88 | 88 | | |
89 | 89 | | |
| |||
0 commit comments