docs: recommend against --strict in migrate documentation#740
Merged
Conversation
The default idempotent restart behavior is safer and more convenient for most users. --strict was added for a specific internal use case and can cause unexpected failures when checkpoints become stale. Document the specific failure scenarios and recommend the default behavior instead. Fixes block#736
f5b8185 to
8cf8637
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the migration documentation to discourage use of --strict and clarify how default restart behavior handles stale checkpoints, aligning guidance with the tool’s safer idempotent resume/restart approach.
Changes:
- Add a prominent warning that
--strictis generally not recommended. - Document concrete failure scenarios where strict mode exits instead of restarting.
- Clarify that the default behavior cleans up stale checkpoints and restarts, usually the desired outcome.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Kiran01bm
approved these changes
May 1, 2026
Collaborator
|
Other places that needs updating ?
The help text does not mention that the flag is discouraged. Since spirit migrate --help is most users' first exposure to the flag, it should reflect the same "not recommended" framing as docs/migrate.md. |
Address Kiran's suggestions: - Update CLI help string for --strict to note it is not recommended - Update resume-from-checkpoint.md to add caveats to --strict recommendations and reframe the Strict mode section
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.
The default idempotent restart behavior is safer and more convenient for most users.
--strictwas added for a specific internal use case and can cause unexpected failures when checkpoints become stale.This updates the
docs/migrate.mdto:--strictFixes #736