fix: embed troubleshoot version string from module dependency #1371
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
banjoh
force-pushed
the
em/get-version-from-runtime
branch
from
7ce8d62 to
b221232
Compare
If troubleshoot is used as a dependency in go.mod, the version information of the release would be missing at runtime. This is because the version string is injected to binaries at build time using linker flags (LD) passed to the compiler (check Makefile)
banjoh
force-pushed
the
em/get-version-from-runtime
branch
from
b221232 to
30374f3
Compare
CpuID
approved these changes
Oct 16, 2023
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.
Description, Motivation and Context
If troubleshoot is used as a dependency (part of your
go.mod), the version information of the release would be missing at runtime i.e empty string whenversion.Version()is called. This is because the version string is injected to binaries at build time using linker flags (LD) passed to the compiler. Built binaries such assupport-bundleandpreflightwill contain a version string, but projects such as KOTS that import troubleshoot as a module will not have a version string set.This PR utilises information fetched from
runtime.BuildInfoat runtime to extract the version info from the troubleshoot module in thego.modfile.Fixes: #1372
Checklist
Does this PR introduce a breaking change?