docs(readme): add an Upgrading section - #557
Merged
Merged
Conversation
The CLI has printed an "Update available!" notice with upgrade commands on every stale invocation since #554, but nothing in the docs was the canonical place that notice's "see:" link led a reader back to. Adds a short section covering the upgrade commands, the FLOWPROOF_NO_UPDATE_CHECK opt-out, and where to check for version-specific behaviour changes before upgrading. Claude-Session: https://claude.ai/code/session_014DBCXghioodAVbbyuyCCWW
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
pip/npmupgrade commands and a link to the release notes, but nothing in the docs was the canonical reference for upgrading — a curious user had nowhere obvious to go beyond the notice itself.FLOWPROOF_NO_UPDATE_CHECKopt-out (existed in code, undocumented until now), and a pointer to CHANGELOG.md for version-specific behaviour changes before upgrading in CI.Test plan
crates/flowproof-cli/src/update_check.rs.