fix(cmd): injects version at build time #226
Open
Conversation
This file contains 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
bartoszmajsak
force-pushed
the
fix-version
branch
2 times, most recently
from
a8472d2 to
44863bb
Compare
A couple of past releases missed aligning hardcoded `main.version` variable with the current tag. This results in confusing output of `gci --version`, where e.g. last release (tagged with `v0.13.5`) prints `0.13.4`. ```shell ❯ go install github.com/daixiang0/[email protected] ❯ gci --version gci version 0.13.4 ``` With this change, `main.Version` is calculated at build time and injected. Therefore it will always contain the tag that it was built from (or `devel` if it's built from untagged commit). ```shell ❯ make build ❯ ./dist/gci -v gci version devel ❯ git tag v0.13.13 ❯ make build BIN_OUTPUT: dist/gci ❯ ./dist/gci -v gci version 0.13.13 ``` With the upcoming `go1.24` release this information can be obtained from `runtime/debug.BuildInfo.Main.Version` [1]. This will simplify the process even further. [1] golang/go#50603 (comment) Signed-off-by: bartoszmajsak <[email protected]>
bartoszmajsak
force-pushed
the
fix-version
branch
from
44863bb to
20c649f
Compare
|
If install gci by |
|
I agree with you. The problem is the go install way. Several projects faced this issue. Some are using strong CI, and PR validation. Some are using google/release-please that can update version wherever needed. Please note, I'm not saying your PR is bad, it's unfortunately not enough. |
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.
A couple of past releases missed aligning hardcoded
main.versionvariablewith the current tag. This results in a confusing output of
gci --version,where e.g. last release (tagged with
v0.13.5) prints0.13.4.With this change,
main.Versionis calculated at build time andinjected. Therefore it will always contain the tag it was
built from (or
develif it's built from untagged commit).With the upcoming
go1.24release this information can be obtained fromruntime/debug.BuildInfo.Main.Version[1].This will simplify the process even further.
[1] golang/go#50603 (comment)
Signed-off-by: bartoszmajsak [email protected]