docs(resume): document cross-version checkpoint compatibility#832
Merged
Kiran01bm merged 2 commits intoMay 10, 2026
Merged
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 17679f43ac
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
morgo
approved these changes
May 10, 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.
What and Why ?
Adds a "Cross-version compatibility" section to
pkg/migration/resume-from-checkpoint.mdexplaining that checkpoint tables are version-specific by design.Spirit deliberately uses
SELECT *when reading the checkpoint table so that any schema drift (columns added, removed, or reordered in a newer release) fails the read. This is intentional — silently reading a checkpoint with a different schema risks misinterpreting fields and corrupting the migration. The behavior was previously documented only in a Go comment inrunner.go(resumeFromCheckpoint) and was not surfaced in the user-facing markdown.What the new section covers
SELECT *is intentional and what it guards against.newMigration()and restarts the copy from scratch silently."could not read from table"error rather than a typedstatus.Err…value (called out as a known observability gap).Scope
Docs-only change. No code or test changes.