fix: resolve version as unknown when installed via go install #84
Conversation
use debug.ReadBuildInfo() fallback when ldflags revision is not set. priority: ldflags → module version (go install tag) → VCS commit hash → unknown. Related to #83
Deploying ralphex with
|
| Latest commit: |
baa3250
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://71294a54.ralphex.pages.dev |
| Branch Preview URL: | https://fix-version-unknown.ralphex.pages.dev |
There was a problem hiding this comment.
Pull request overview
Adds a runtime fallback for the ralphex version string so binaries installed via go install display a meaningful version/commit even when ldflags aren’t injected (addressing issue #83).
Changes:
- Introduce
resolveVersion()that prefers ldflagsrevision, then Go module version fromdebug.ReadBuildInfo(), then a short VCS commit hash. - Switch startup version printing to use
resolveVersion(). - Add unit tests covering ldflags and fallback behavior.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| cmd/ralphex/main.go | Adds resolveVersion() using runtime/debug.ReadBuildInfo() and prints resolved version. |
| cmd/ralphex/main_test.go | Adds tests for resolveVersion() behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| t.Run("fallback_to_build_info", func(t *testing.T) { | ||
| orig := revision | ||
| t.Cleanup(func() { revision = orig }) | ||
| revision = "unknown" | ||
| // in test context, debug.ReadBuildInfo returns (devel) module version | ||
| // but VCS info should be available from the git repo | ||
| v := resolveVersion() | ||
| assert.NotEmpty(t, v) | ||
| }) |
There was a problem hiding this comment.
fallback_to_build_info currently only asserts the resolved version is non-empty, but resolveVersion() can legitimately return the literal string "unknown" here, making this test pass even if the build-info fallback logic is broken. Consider asserting that the result is not equal to "unknown" when build info contains either a non-"(devel)" module version or a vcs.revision setting, and otherwise explicitly asserting it equals "unknown" (branching based on debug.ReadBuildInfo() in the test to avoid flakiness).
1 participant
go installdoesn't inject ldflags, sorevisionstays"unknown". AddedresolveVersion()fallback usingdebug.ReadBuildInfo():go install @latest→ module version from tag (e.g.v0.10.0)go install @v0.10.0→v0.10.0go buildwithout ldflags → short VCS commit hash (e.g.abc1234)make build→ unchanged, ldflags take priorityRelated to #83