[docs] Add comments / instructions about the new database migrations#4733
Draft
junaway wants to merge 1 commit into
Draft
[docs] Add comments / instructions about the new database migrations#4733junaway wants to merge 1 commit into
junaway wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
dosubot
Bot
added
size:M
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
📝 WalkthroughSummary by CodeRabbit
WalkthroughFive documentation files are updated to declare the legacy ChangesParked Migration Chain Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds prominent documentation banners and contributor guidance to prevent new Alembic revisions from being created in the legacy parked core/ and tracing/ migration chains, and to direct authors to the active OSS/EE split chains instead.
Changes:
- Adds
[!IMPORTANT]“parked chain” warnings to OSS and EEcore/andtracing/migration READMEs. - Documents the active chain matrix (OSS/EE, core/tracing, version tables, roots) in the OSS
core/README. - Adds contributor instructions in
api/AGENTS.mdon which chain to use for shared vs EE-only schema changes.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| api/oss/databases/postgres/migrations/tracing/README.md | Adds parked-chain warning and directs new tracing migrations to tracing_oss/ / tracing_ee/. |
| api/oss/databases/postgres/migrations/core/README.md | Adds parked-chain warning plus an active-chain matrix and guidance for authoring in core_oss/ / core_ee/. |
| api/ee/databases/postgres/migrations/tracing/README.md | Adds parked-chain warning for EE tracing legacy chain and points to active chains. |
| api/ee/databases/postgres/migrations/core/README.md | Adds parked-chain warning for EE core legacy chain and points to active chains. |
| api/AGENTS.md | Adds contributor guidance on selecting the correct Alembic chain for new schema migrations. |
Comments suppressed due to low confidence (1)
api/ee/databases/postgres/migrations/tracing/README.md:7
- The banner says
tracing/is parked, but theMaking migrationscommand below runs with-w .../migrations/core(wrong directory) and would create a revision in the parked chain. It should point at the activetracing_oss/(shared) ortracing_ee/(EE-only) chain instead.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+22
to
+23
| > The commands below still describe the alembic mechanics, but swap the `-w .../core` | ||
| > working directory for `.../core_oss` (or the right active chain) when creating revisions. |
Comment on lines
+22
to
+23
| > The commands below still describe the alembic mechanics, but swap the `-w .../core` | ||
| > working directory for `.../core_oss` (or the right active chain) when creating revisions. |
Comment on lines
+4
to
+8
| > **This `tracing/` chain is PARKED (frozen legacy history).** Do **not** add new | ||
| > revisions here — it ends at `park00000000` and never advances. Author new tracing | ||
| > migrations in `tracing_oss/` (shared, runs in both editions) or `tracing_ee/` (EE-only). | ||
| > See the parked `core/README.md` banner and | ||
| > `docs/designs/oss-ee-convergence/migration-chains-and-edition-switch.md`. |
Comment on lines
+4
to
+8
| > **This `tracing/` chain is PARKED (frozen legacy history).** Do **not** add new | ||
| > revisions here — it ends at `park00000000` and never advances. Author new tracing | ||
| > migrations in `tracing_oss/` (shared, runs in both editions) or `tracing_ee/` (EE-only). | ||
| > See the parked `core/README.md` banner and | ||
| > `docs/designs/oss-ee-convergence/migration-chains-and-edition-switch.md`. |
Comment on lines
+4
to
+8
| > **This `core/` chain is PARKED (frozen legacy history).** Do **not** add new revisions | ||
| > here — it ends at `park00000000` and never advances. Shared schema changes go in | ||
| > `oss/databases/postgres/migrations/core_oss/` (EE ships and runs the `oss/` tree); | ||
| > EE-only schema goes in `core_ee/`. Full rules: | ||
| > `docs/designs/oss-ee-convergence/migration-chains-and-edition-switch.md`. |
Comment on lines
+4
to
+8
| > **This `core/` chain is PARKED (frozen legacy history).** Do **not** add new revisions | ||
| > here — it ends at `park00000000` and never advances. Shared schema changes go in | ||
| > `oss/databases/postgres/migrations/core_oss/` (EE ships and runs the `oss/` tree); | ||
| > EE-only schema goes in `core_ee/`. Full rules: | ||
| > `docs/designs/oss-ee-convergence/migration-chains-and-edition-switch.md`. |
Comment on lines
+91
to
+93
| Full model (version tables, fresh-install/upgrade/OSS→EE-switch flows, FK and replay-skew | ||
| rules): `docs/designs/oss-ee-convergence/migration-chains-and-edition-switch.md`. The | ||
| parked `core/README.md` covers alembic mechanics. |
Contributor
Railway Preview Environment
Updated at 2026-06-18T16:45:05.556Z |
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.
No description provided.