Repository navigation
feat: warn when src-cli is older than the instance's recommended version - #1403
Merged
Merged
Conversation
Before running a command, src does a best-effort check of the running version against the version recommended by the configured instance (/.api/src-cli/version) and prints a single stderr warning when behind. Fail-open, 3s timeout, stderr only so --json is unaffected. Skips version/help/no-arg, dev builds, and SRC_SKIP_VERSION_CHECK. Compares major/minor/patch only. Adds unit tests. Closes #930. Supersedes #1339, #1343.
- Fix a nil pointer panic on every command in release builds: the check built its API client from a zero-value api.Flags. - Run the check after flags and config are resolved, so -endpoint and -config are honored and the right instance is asked. - Ask the instance at most once every 24 hours per endpoint, caching the answer, including a failed lookup, under the user cache directory, so an instance that does not answer cannot delay every command. - Compare versions with Masterminds/semver, which is already linked into the binary, instead of a hand-written parser. - Skip 'src version' by its parsed subcommand instead of scanning every argument for the word. - Test the check end to end against a fake instance. Amp-Thread-ID: https://ampcode.com/threads/T-01a1c29c-9f51-7761-a4ba-4d4f46dcd4ef Co-authored-by: Amp <amp@ampcode.com>
The check ran before the subcommand's flags were parsed, so it ignored -insecure-skip-verify and never warned on instances with an untrusted certificate. It also ran twice for nested legacy commands such as 'src repos list', which printed the warning twice. Run it once per process from config.apiClient instead, using the client the command asked for. Commands that never talk to the instance, such as 'src search -h', no longer trigger a lookup. Amp-Thread-ID: https://ampcode.com/threads/T-01a1c29c-9f51-7761-a4ba-4d4f46dcd4ef Co-authored-by: Amp <amp@ampcode.com>
'src version' was the one command that never warned. It now prints the warning from the answer it just got from the instance, and caches that answer, so the commands that follow warn about the same version. It still makes a single request, and 'src version -client-only' still makes none: the check that other commands get from config.apiClient keeps skipping 'src version'. Amp-Thread-ID: https://ampcode.com/threads/T-01a1c29c-9f51-7761-a4ba-4d4f46dcd4ef Co-authored-by: Amp <amp@ampcode.com>
The warning already names SRC_SKIP_VERSION_CHECK and links to the upgrade instructions, and CHANGELOG.md describes the feature. This reverts commit 71363c8. Amp-Thread-ID: https://ampcode.com/threads/T-01a1c29c-9f51-7761-a4ba-4d4f46dcd4ef Co-authored-by: Amp <amp@ampcode.com>
marcleblanc2
marked this pull request as ready for review
November 10, 2026 00:49
marcleblanc2
enabled auto-merge (squash)
November 10, 2026 00:49
BolajiOlajide
approved these changes
Nov 10, 2026
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.
Closes #930. An alternative to #1347: this branch keeps @Montana's commit from #1347 and fixes it on top.
srcnow warns on stderr when it is older than the version your instance recommends (/.api/src-cli/version, the same lookupsrc versiondoes):How it works
config.apiClient, so it uses the command's own endpoint and flags, such as-insecure-skip-verify. Commands that never talk to the instance, such assrc search -h, do no lookup.os.UserCacheDir()/sourcegraph/src-cli/. Failed lookups are cached too.src versionalways asks the instance, as before. It now warns from that answer and writes it to the cache, so the commands that follow warn about the same version. It still makes one request, andsrc version -client-onlymakes none.SRC_SKIP_VERSION_CHECKis set.Fixes on top of #1347
&api.Flags{}, whichinternal/apidereferences, so every command in a release build crashed. Dev builds skip the check, which hid it.flag.Parse(), so it ignored-endpoint,-config, and-insecure-skip-verify.src versionandsrc search versionskipped the check.src versionnow warns from its own lookup, and arguments are no longer scanned forversion.Masterminds/semverinstead of a hand-written parser. It is already linked in throughsourcegraph/lib;go.modmoves it from indirect to direct.CHANGELOG.mdentry. The warning itself namesSRC_SKIP_VERSION_CHECKand links to the upgrade instructions.Decisions to review
config.apiClient, the one place where the endpoint and a command's parsed flags meet.srcis outdated, including in CI and when stderr is not a terminal.7.4.0-rc.0is warned when the instance recommends7.4.0.-insecure-skip-verify.Test plan
go test -race ./cmd/srcand./dev/go-lint.sh ./cmd/src/...pass.Real instance. Built this branch with
BuildTagset to6.4.1and to7.6.0, and ran both against sourcegraph.sourcegraph.com, which recommends7.6.0:src version(6.4.1)Recommended version: 7.6.0 or later, then one warning on stderrsrc version(7.6.0)src version -client-only(6.4.1)src repos list -first 1(6.4.1, legacy command)src api -query '...'(6.4.1,urfave/clicommand)src search -json '...'(6.4.1)SRC_SKIP_VERSION_CHECK=1 src repos list -first 1(6.4.1)src repos list -first 1(7.6.0, same cache file)src repos list -h(6.4.1)SRC_ENDPOINTset to a dead endpoint,src -endpoint=<instance> repos list -first 1(6.4.1)-endpointinstance; the command succeedsLocal fake instance, only for what the real instance cannot show: request counts, a changing answer, an untrusted certificate, and an instance that hangs. Built as
6.4.1; the fake recommends6.5.0:src repos list, thensrc users list/.api/src-cli/version, from the first commandsrc versionon an empty cachesrc version -client-only99.0.0, thensrc repos list6.5.0; no version requestsrc version, thensrc repos list99.0.0; one version request, fromsrc versionsrc users list -insecure-skip-verifysrc users listsrc users listtwice