Repository navigation
docs: publish the installation-route upgrade contract - #2630
Open
codeforester wants to merge 2 commits into
Open
codeforester wants to merge 2 commits into
codeforester wants to merge 2 commits into
Conversation
6 tasks
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.
Summary
Users lack one reliable upgrade procedure across Homebrew, mutable source checkouts, and stable source tags. Add a canonical upgrade matrix and recovery guide, then link installation, shell, FAQ, command, and agent guidance to it.
The guide distinguishes current-main behavior from v1.10.5:
update --releaseand reconciliation after an unchanged Homebrew version were added later. It covers older-version fallback, direct package-manager/Git operations, active-install selection, setup failures after a ref change, runtime verification, and trust re-review.Issue
Fixes #2597
Related audit corrections are in #2629 / #2628. This PR can be reviewed independently; both are documentation-only and target main.
Validation
bats cli/bash/commands/basectl/tests/update.bats: all 28 cases passed, covering stable-tag upgrade/refusal/recovery, Homebrew reconciliation including unchanged versions, and mutable/project update behavior.update.sh;git diff --checkpassed.Design Impact
Documents the implemented update routes and their boundaries. No runtime changes, automatic trust approval, downgrade capability, or new release-verification guarantee is introduced. Remote tag matching is explicitly distinguished from immutable release/BOM evidence.
Docs Impact
docs/upgrading.mdis the canonical upgrade procedure. README, FAQ, documentation index, bootstrap recipes, shell-startup guidance, Homebrew rehearsal, command reference, andskills.mdnow point to it. Duplicate upgrade procedures were consolidated to reduce synchronization risk. The contract registry links the guide to existing update behavior tests while preserving the need for prose review.AI Context Impact
Add the route-specific update summary and canonical guide reference to
.ai-context/COMMANDS.md.Release Notes
Add the missing Unreleased notes for stable-source
--releasesupport and unconditional Homebrew runtime reconciliation. Published release sections remain unchanged.Demo Impact
None. Existing command and demo behavior is unchanged; upgrade verification and the distinction between Base and consumer-project tests are documented.