Skip to content

docs(cli): document os migrate + dev autoMigrate self-heal (#2186 follow-up) - #2205

Merged
xuyushun441-sys merged 1 commit into
mainfrom
docs/os-migrate
Jun 22, 2026
Merged

xuyushun441-sys merged 1 commit into
mainfrom
docs/os-migrate

Conversation

@xuyushun441-sys

Copy link
Copy Markdown
Collaborator

Follow-up to #2196 (#2186) — the schema-drift / os migrate feature shipped with no documentation. This adds it.

  • content/docs/getting-started/cli.mdx — new Schema migrations section: os migrate plan / os migrate apply, the safe / needs-confirm / destructive categories, --allow-destructive, and the dev-only autoMigrate:'safe' self-heal (force-disabled in production; SQLite reconciles via data-preserving table rebuild).
  • skills/objectstack-platform/SKILL.md — os migrate plan/apply added to the CLI cheat sheet (the ops/migrations skill).
  • skills/objectstack-data/SKILL.md — new Schema evolution on an existing database note: the sync is additive-only, so relaxing required / type changes / drops on a live DB need os migrate (dev auto-heals loosening). Calls out the tell-tale — /meta reports a field optional but a write still 400s "<field> is required" = a stale NOT NULL column (physical drift), not a validator bug.

Docs/skills only — no versioned package touched (hence skip-changeset). Skill edits are body-only, so the frontmatter-generated skill docs don't drift.

🤖 Generated with Claude Code

…ollow-up)

Follow-up to #2196 — the schema-drift / `os migrate` feature shipped with no docs.

- cli.mdx: new "Schema migrations" section — `os migrate plan/apply`, the
  safe/needs-confirm/destructive categories, `--allow-destructive`, and the
  dev-only `autoMigrate:'safe'` self-heal (force-disabled in production).
- objectstack-platform SKILL: add `os migrate plan/apply` to the CLI cheat sheet.
- objectstack-data SKILL: "Schema evolution on an existing database" — the sync
  is additive-only; relaxing `required` / type changes / drops on a live DB need
  `os migrate` (dev auto-heals loosening). Names the tell-tale: `/meta` says
  optional but a write 400s "<field> is required" = stale NOT NULL, not a
  validator bug.

Body-only skill edits (frontmatter unchanged → generated skill docs don't drift).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@xuyushun441-sys xuyushun441-sys added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Jun 22, 2026
@vercel

vercel Bot commented Jun 22, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
spec Ready Ready Preview, Comment Jun 22, 2026 12:33pm

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/s and removed documentation Improvements or additions to documentation labels Jun 22, 2026
@xuyushun441-sys
xuyushun441-sys merged commit a210ed1 into main Jun 22, 2026
18 checks passed
@xuyushun441-sys
xuyushun441-sys deleted the docs/os-migrate branch June 22, 2026 12:37

This branch was successfully deployed

1 active deployment
Preview — 5a6bbd0e Deployed Jun 22, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/s skip-changeset PR has no user-facing published change; bypasses the changeset gate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants