docs(scripts): update version example in run-upgrade-test.sh - #252
docs(scripts): update version example in run-upgrade-test.sh#252Lesnak1 wants to merge 3 commits into
Conversation
osr21
left a comment
There was a problem hiding this comment.
Checked both hunks against the surrounding context, and they land very differently — one is a genuine staleness fix, the other changes a deliberately old version and makes the doc wrong.
scripts/run-upgrade-test.sh — fine. The (e.g. 0.6.0-dev) is just illustrating the GHCR dev-tag format for the --from/--to overrides, and pointing it at the current release keeps the example copy-pasteable. No objection.
crates/quake/README.md — please revert this hunk. Read the sentence being edited:
Upgrade scenarios can pin an older
arc_consensusimage tag (e.g.v0.6.0). Quake derives CLI flags from theStartCmddefinition compiled into its own binary, which may have gained, renamed, or removed flags since that image shipped.
The entire section ("Matching Flags to the Target Image Version") is about what happens when the pinned image is older than the current binary — Quake rewrites the flag set down to a compatible subset. v0.6.0 here isn't a stale reference to the current release; it's a deliberately old tag chosen because upgrade tests start from an old version and upgrade away from it. Substituting the current release breaks the illustration: pinning v0.7.3 today is pinning the newest image, i.e. exactly the case where no flag-downgrade happens, so the example no longer demonstrates the mechanism the paragraph explains. (If anything, as future releases ship, v0.6.0 becomes a better example of "older," not a worse one.)
This is the classic hazard of version-literal sweeps: not every old version string is stale. The ones on main split three ways —
- genuinely stale (points operators at the wrong thing today): the two files already covered by #226/#238, plus arguably the script example here;
- deliberately historical:
CHANGELOG.md,BREAKING_CHANGES.md(v0.6.0 is the baseline release those documents are about), and the quake README/test fixtures incli_version.rs, where old tags are the test subject; - arbitrary format examples: the
workflow_dispatchinput descriptions inbuild-docker.yaml/release-binaries.yaml("e.g. v0.6.0"), where any well-formed tag serves and churning them each release adds diff noise for zero operator benefit.
Only the first class is worth touching. So: drop the README hunk, keep the script hunk, and this becomes a clean, correctly scoped follow-up to #226/#238.
|
Thanks @osr21 for the great breakdown on version literal classification! I've reverted the |
|
Confirmed on the new head ( Nothing left to flag from my side. With this, the whole staleness cluster is cleanly partitioned: #226 (installation.md table + install command), #238 (compose comments, made release-proof via |
Summary
Updates the CLI usage version example in
scripts/run-upgrade-test.shfrom0.6.0-devto0.7.3-dev.Rationale
Ensures script documentation aligns with the active Arc Testnet release
v0.7.3.