Skip to content

docs(schema): schema-migrations.md + cli --help expand + AGENTS (#420)#423

Merged
hideyukiMORI merged 1 commit into
mainfrom
docs/420-schema-migrations
May 22, 2026
Merged

docs(schema): schema-migrations.md + cli --help expand + AGENTS (#420)#423
hideyukiMORI merged 1 commit into
mainfrom
docs/420-schema-migrations

Conversation

@hideyukiMORI
Copy link
Copy Markdown
Owner

FT17 docs PR (#422 framework port が landed 後)。

New file

  • `docs/development/schema-migrations.md` — TL;DR / why no auto-apply / emit-or-warn 表 / driver support / output 構造 / deploy hook example / migration file versioning

CLI --help expand (F-4)

`cli/schemaDiff.php --help` を multi-line に拡張 (USAGE / OPTIONS / EXAMPLES / OUTPUT / EXIT CODES / NOT EMITTED / SEE ALSO)。

AGENTS.md

"Read First" 表に schema-migrations.md を追加。

Framework code 変更なし。

Test plan

  • composer test 138/138
  • composer analyze (Phan) exit 0
  • composer format:check exit 0
  • `composer schema:diff -- --help` (実行用 alias 経由) で expanded help

Closes #420.

FT17 docs PR。#422 (SchemaDiffer + cli/schemaDiff.php) merged 後の状態を
集約。

### New file

- docs/development/schema-migrations.md
  - TL;DR (5 step workflow)
  - Why no auto-apply (3 reasons)
  - 何が emit され / 何が warning だけになるかの表 2 種
  - Driver support (MySQL + SQLite)
  - Output 構造の説明 (stdout vs stderr 分離)
  - Recommended deploy hook (bash example、CI exit-1 で operator action gate)
  - Versioning migration files
  - 関連 link (ADR-0005 / 0009、REPORT_commercial_feasibility.md、#421)

### CLI --help expand (F-4)

cli/schemaDiff.php の --help が短い "see docblock" から、USAGE / OPTIONS
/ EXAMPLES / OUTPUT / EXIT CODES / NOT EMITTED / SEE ALSO の multi-line
help に。

### AGENTS.md "Read First"

\`docs/development/schema-migrations.md\` への 1 行リンク追加。

Framework code 変更なし (CLI の --help 出力以外)。

Closes #420.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@hideyukiMORI hideyukiMORI merged commit 5fbdae3 into main May 22, 2026
2 checks passed
@hideyukiMORI hideyukiMORI deleted the docs/420-schema-migrations branch May 22, 2026 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

FT17 docs: schema-migrations.md + ADR cross-links + AGENTS + --help expand (#417)

1 participant