Add build flags #76
Open
Add build flags #76
Conversation
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
aarongable
reviewed
May 20, 2024
|
|
||
| - name: build binary | ||
| run: go build | ||
| run: go build -ldflags "-X github.com/letsencrypt/unbound_exporter/util.BuildID=$(git rev-parse --short HEAD) -X github.com/letsencrypt/unbound_exporter/util.BuildBranch=$(git rev-parse --abbrev-ref HEAD) -X github.com/letsencrypt/unbound_exporter/util.BuildTime=$(date +%F-%T -u)" |
There was a problem hiding this comment.
Suggested change
| run: go build -ldflags "-X github.com/letsencrypt/unbound_exporter/util.BuildID=$(git rev-parse --short HEAD) -X github.com/letsencrypt/unbound_exporter/util.BuildBranch=$(git rev-parse --abbrev-ref HEAD) -X github.com/letsencrypt/unbound_exporter/util.BuildTime=$(date +%F-%T -u)" | |
| run: go build -ldflags "-X github.com/letsencrypt/unbound_exporter/build.Revision=$(git rev-parse --short HEAD) -X github.com/letsencrypt/unbound_exporter/build.Branch=$(git rev-parse --abbrev-ref HEAD)" |
Comment on lines
+5
to
+7
| // BuildID is set by the compiler (using -ldflags "-X util.BuildID $(git rev-parse --short HEAD)") | ||
| // and is used by GetID | ||
| var BuildID string |
There was a problem hiding this comment.
Suggested change
| // BuildID is set by the compiler (using -ldflags "-X util.BuildID $(git rev-parse --short HEAD)") | |
| // and is used by GetID | |
| var BuildID string | |
| // Revision is set by the compiler (using -ldflags "-X build.Revision $(git rev-parse --short HEAD)") | |
| // and is used by GetRevision | |
| var Revision string |
Comment on lines
+9
to
+10
| // BuildBranch is set by the compiler and is used by GetBranch | ||
| var BuildBranch string |
There was a problem hiding this comment.
Suggested change
| // BuildBranch is set by the compiler and is used by GetBranch | |
| var BuildBranch string | |
| // Branch is set by the compiler and is used by GetBranch | |
| var Branch string |
Comment on lines
+12
to
+15
| // GetBuildID identifies what build is running. | ||
| func GetID() (BuildID string) { | ||
| if BuildID != "" { | ||
| return BuildID |
There was a problem hiding this comment.
Suggested change
| // GetBuildID identifies what build is running. | |
| func GetID() (BuildID string) { | |
| if BuildID != "" { | |
| return BuildID | |
| // GetRevision identifies what commit this binary was built from. | |
| func GetRevision() string { | |
| if Revision != "" { | |
| return Revision |
| // and is used by GetID | ||
| var BuildID string | ||
|
|
||
| // BuildBranch is set by the compiler and is used by GetBranch |
There was a problem hiding this comment.
Suggested change
| // BuildBranch is set by the compiler and is used by GetBranch | |
| // BuildBranch is set by the compiler (using -ldflags "-X build.Branch $git rev-parse --abbrev-rev HEAD)") | |
| // and is used by GetBranch |
|
|
||
| const Unspecified = "Unspecified" | ||
|
|
||
| // BuildID is set by the compiler (using -ldflags "-X util.BuildID $(git rev-parse --short HEAD)") |
There was a problem hiding this comment.
Suggested change
| // BuildID is set by the compiler (using -ldflags "-X util.BuildID $(git rev-parse --short HEAD)") | |
| // Revision is set by the compiler (using -ldflags "-X build.Revision $(git rev-parse --short HEAD)") |
Comment on lines
+21
to
+24
| // GetBranch identifies the building host | ||
| func GetBranch() (BuildBranch string) { | ||
| if BuildBranch != "" { | ||
| return BuildBranch |
There was a problem hiding this comment.
Suggested change
| // GetBranch identifies the building host | |
| func GetBranch() (BuildBranch string) { | |
| if BuildBranch != "" { | |
| return BuildBranch | |
| // GetBranch identifies what git branch this binary was built from. | |
| func GetBranch() string { | |
| if Branch != "" { | |
| return Branch |
|
I was planning to push up a PR which would add a This is what the other Prometheus exporters do: https://github.com/prometheus/node_exporter/blob/3afc0a341e3c2c6605b18a882fb045318c18c444/node_exporter.go#L123 - the functionality uses the prometheus.Version data. |
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.
Added a new
//utilpackage which contains some variables set by the builder at build time to output more information during process startup. This was largely copied from boulder. See below:Fixes #75