docs: warn that resume across Spirit binary versions is not supported#841
Merged
morgo merged 1 commit intoMay 13, 2026
Merged
Conversation
Spirit's resume-from-checkpoint logic only catches a checkpoint-table schema mismatch (via SELECT *); semantic drift across binary versions with an unchanged schema is silently accepted. Document this caveat in the README and under checkpoint-max-age, and update the strict section to list the schema-mismatch case as another scenario where strict mode hard-fails instead of restarting. Co-authored-by: Amp <amp@ampcode.com> Amp-Thread-ID: https://ampcode.com/threads/T-019e18d9-2678-7179-9961-b7efb8c0b807
Collaborator
I don't think we need to go that far, since the data within the table (provided columns line up) is safe to restore between versions. It is reasonable to expect that we will change the checkpoint format again though, for example if we implement #270 it will be a format change. |
morgo
approved these changes
May 13, 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
2 participants
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 ?
Spirit's resume-from-checkpoint logic only catches a checkpoint-table schema mismatch (via SELECT *); semantic drift across binary versions with an unchanged schema is silently accepted.
This change documents this caveat in the README and under checkpoint-max-age, and update the strict section to list the schema-mismatch case.
Next Step
Also, as a next step - I am thinking of adding a
spirit_versioncolumn to the checkpoint table; refuse resume if it doesn't matchbuildinfo.Version().Behaviour wise - default: warn + restart fresh; under
--strict:hard‑fail with a new sentinel error likeErrSpiritVersionMismatchadded to the strict whitelist at runner.go:799).