docs(BA-5414): document Alembic migration backport strategy#10607
Open
docs(BA-5414): document Alembic migration backport strategy#10607
Conversation
Add ALEMBIC.md with the full backport procedure, idempotent writing rules, and real-world examples so developers can safely backport migrations to release branches. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds repository-wide documentation for how to backport Alembic migrations across release branches while keeping main consistent, and wires that doc into existing documentation entrypoints.
Changes:
- Add root
ALEMBIC.mddescribing principles, procedure, and idempotent migration patterns for backports. - Update
CLAUDE.mdto includeALEMBIC.mdin the Documentation Index and add a brief backport note. - Update component Alembic READMEs to point readers to the root
ALEMBIC.md.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
ALEMBIC.md |
New canonical backport strategy doc (procedure + idempotent patterns + examples). |
CLAUDE.md |
Adds doc index entry and brief backport guidance pointing to ALEMBIC.md. |
src/ai/backend/manager/models/alembic/README |
Adds pointer to root ALEMBIC.md. |
src/ai/backend/account_manager/models/alembic/README |
Adds pointer to root ALEMBIC.md. |
src/ai/backend/appproxy/coordinator/models/alembic/README |
Adds pointer to root ALEMBIC.md. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Clarify Principle 3: editing down_revision is allowed only when inserting a backport into the main chain before merge - Use full repo paths in Real-World Example references Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Every migration file must include a "# Part of: <version>" comment next to the revision identifiers to trace which release introduced the schema change. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Move backport strategy documentation from root ALEMBIC.md to manager/models/alembic/ as README.md (full docs) and CLAUDE.md (AI agent guardrails). Account manager and appproxy alembic READMEs now link to the manager's canonical document. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ALEMBIC.mdwith the full Alembic migration backport strategy: principles, step-by-step procedure, idempotent writing rules, and real-world examplesCLAUDE.mdALEMBIC.mdreferences to all 3 component alembic READMEs (manager, account_manager, appproxy coordinator)🤖 Generated with Claude Code