docs: simplify the v2 to v3 migration guide - #1828
Merged
Merged
Conversation
Contributor
|
Important Review skippedReview was skipped as selected files did not have any reviewable changes. 💤 Files selected but had no reviewable changes (1)
⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
You can disable this status message by setting the Use the checkbox below for a quick retry:
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 |
Strip design rationale, state every change from a v2 baseline rather than from intermediary states on main, and merge the four package-rename sections and the conn abbreviation section into their peers. Add a "Changes the compiler will not catch" index at the top of the v3 section linking the six changes that compile silently but behave differently.
spydon
force-pushed
the
docs/simplify-migration-guide
branch
from
September 11, 2026 09:34
185d6bc to
8622693
Compare
Tr00d
approved these changes
Sep 11, 2026
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.
Rewrites
MIGRATION.mdso it reads as a list of things to change rather than an account of why they changed. 1893 lines down to 1566.What changed
Design rationale removed. Every "why we did this" passage is gone: why
realtime_clientwas a poor package name, why the socket state was exposed twice, why the broadcast REST fallback was a problem, whyPostgrestClienthad to become stateless, why one status stream beats four callbacks. What remains per section is the change, a before/after table or snippet, and any follow-up action.Everything stated from a v2 baseline. A few entries described renames relative to intermediary states that only ever existed on
main:TableSnapshotScope.value→TableSnapshotScope.name, butTableSnapshotScopedoes not exist in v2. It now readsLoadTableSnapshots.value→TableSnapshotScope.name.realtime_client:andstorage_client:; they now use the v3 package names.LoadTableSnapshotsrow in the singularization table is attributed toicebergrather thansupabase_storage, which is where the type lives in v3.I checked every "Before" symbol in the guide against the last v2 tag of its package (
gotrue-v2.27.2,storage_client-v2.8.0,realtime_client-v2.13.0,functions_client-v2.7.1,postgrest-v2.9.1,supabase-v2.16.1,supabase_flutter-v2.17.2) to confirm it actually exists there.Sections merged. The four package-rename sections collapse into one "The client packages are renamed" with three tables: dependency, import, and the auth type renames. The standalone "
connabbreviations onRealtimeClientspelled out" section folds into the existing abbreviations table.One section added. "Changes the compiler will not catch" at the top of the v3 section links the six changes that compile silently but behave differently:
order()defaulting to ascending, theconnectionStatetype change, theHttpMethodindex shift,userUpdatedon email and phone confirmation, the PostgREST backoff defaults, and writes without aselect()resolving tovoid.Drive-by fix. A snippet in the realtime codec section still passed
anonKey:toSupabase.initialize, contradicting the section that makespublishableKeyrequired.Coverage
All 45 original sections are accounted for in the 42 that remain (four merged away, one added). No migration instruction was dropped.