Upgrade story: Upgrading.md + min_supported pinning + .new recipe (#96)#122
Merged
Conversation
… reconciliation recipe Closes #96. - New wiki page `docs/docs/wiki/Upgrading.md` covering the full upgrade contract: what `setup update` does step-by-step, the `.new` reconciliation workflow (diff, merge, delete), how to roll back via git, how to read the CHANGELOG's Breaking section, and when `setup update` is not the right tool. Linked from `_meta.json` and the README. - `scaffold-version.json` now carries `min_supported_scaffold_version`, pinned to the installed scaffold version on every write (both `write_scaffold_version` and `write_scaffold_hashes`). `read_min_supported_version` exposes it. - `setup update` refuses to run when the installed scaffold is older than the project's recorded floor. The error follows the standard three-line shape (cause / next / see) and points at the new wiki page. New `--force` flag bypasses the gate for the rare case where the user really does want to downgrade. Legacy snapshots without the field run as before. - When `setup update` produces `.new` files, it now prints a concrete copy-pasteable reconciliation recipe (diff, merge, delete the sidecar, re-run `eval`) plus a link to the wiki page. - New `tests/test_upgrade_compatibility.py` covers: snapshot records the field, comparator semantics, the gate refuses on older / passes on matching / passes on legacy, `--force` bypasses, the wiki page covers the required topics.
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
1 participant
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.
Summary
Closes #96.
Test plan