fix: preserve wfctl release version#750
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes wfctl version reporting so release builds can reliably inject the release tag via linker -ldflags -X main.version=..., while still deriving a useful version from Go build metadata for module-installed/dev builds. It also adds automation to notify workflow-registry after stable (non-prerelease) workflow releases.
Changes:
- Make
cmd/wfctl’sversionvariable linker-overridable and move build-metadata fallback intoinit(). - Add a regression test that builds
wfctlwith-X main.version=...and assertswfctl --versionmatches. - Add a release workflow job to repository-dispatch
workflow-registryafter non-prerelease releases.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
cmd/wfctl/main.go |
Switches version to a constant initializer ("dev") so -X main.version=... works; falls back to debug.ReadBuildInfo() in init(). |
cmd/wfctl/main_test.go |
Adds regression coverage that builds a wfctl binary with -ldflags -X main.version=... and verifies --version output. |
.github/workflows/release.yml |
Adds a post-release repository-dispatch notification to GoCodeAlone/workflow-registry for stable tags. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
⏱ Benchmark Results✅ No significant performance regressions detected. benchstat comparison (baseline → PR)
|
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
versionvariable linker-overridable by release-ldflags -X main.version=...builds, with build metadata fallback for dev/module installs.-X main.version=v9.9.9and verifieswfctl --versionreports that exact tag.workflow-registryafter non-prerelease workflow releases so registry core manifests and README indexes can refresh.Adversarial review
-Xcannot override a string variable initialized frombuildVersion(); the new initializer is a plain string and fallback runs ininit.repo_dispatch_tokenpattern and only runs after release for non-prerelease tags.actionlint .github/workflows/release.ymlreports pre-existing shellcheck warnings at release.yml lines 145 and 287; the new registry notification block is not implicated.Test Plan
GOWORK=off go test ./cmd/wfctl -run 'Test(BuildVersionStripsDirtyMarker|LinkedVersionOverridesBuildInfo|RunUpdate_CheckOnly|RunUpdate_AlreadyLatest|CheckForUpdateNotice_SkipsDevBuild)' -count=1 -vgit diff --check