- Notifications
You must be signed in to change notification settings - Fork929
feat: Add buildinfo package to embed version#840
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
7 changes: 5 additions & 2 deletions.goreleaser.yml
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
1 change: 1 addition & 0 deletions.vscode/settings.json
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -5,6 +5,7 @@ | ||
| "coderd", | ||
| "coderdtest", | ||
| "codersdk", | ||
| "devel", | ||
| "drpc", | ||
| "drpcconn", | ||
| "drpcmux", | ||
83 changes: 83 additions & 0 deletionscli/buildinfo/buildinfo.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| package buildinfo | ||
| import ( | ||
| "path" | ||
| "runtime/debug" | ||
| "sync" | ||
| "time" | ||
| "golang.org/x/mod/semver" | ||
| ) | ||
| var ( | ||
| buildInfo *debug.BuildInfo | ||
| buildInfoValid bool | ||
| readBuildInfo sync.Once | ||
| // Injected with ldflags at build! | ||
| tag string | ||
| ) | ||
| // Version returns the semantic version of the build. | ||
| // Use golang.org/x/mod/semver to compare versions. | ||
| func Version() string { | ||
| revision, valid := revision() | ||
| if valid { | ||
| revision = "+" + revision[:7] | ||
| } | ||
| if tag == "" { | ||
| return "v0.0.0-devel" + revision | ||
| } | ||
| if semver.Build(tag) == "" { | ||
| tag += revision | ||
| } | ||
| return "v" + tag | ||
| } | ||
| // ExternalURL returns a URL referencing the current Coder version. | ||
| // For production builds, this will link directly to a release. | ||
| // For development builds, this will link to a commit. | ||
| func ExternalURL() string { | ||
| repo := "https://github.com/coder/coder" | ||
| revision, valid := revision() | ||
| if !valid { | ||
| return repo | ||
| } | ||
| return path.Join(repo, "commit", revision) | ||
| } | ||
| // Time returns when the Git revision was published. | ||
| func Time() (time.Time, bool) { | ||
| value, valid := find("vcs.time") | ||
| if !valid { | ||
| return time.Time{}, false | ||
| } | ||
| parsed, err := time.Parse(time.RFC3339, value) | ||
| if err != nil { | ||
| panic("couldn't parse time: " + err.Error()) | ||
| } | ||
| return parsed, true | ||
| } | ||
| // revision returns the Git hash of the build. | ||
| func revision() (string, bool) { | ||
| return find("vcs.revision") | ||
| } | ||
| // find panics if a setting with the specific key was not | ||
| // found in the build info. | ||
| func find(key string) (string, bool) { | ||
| readBuildInfo.Do(func() { | ||
| buildInfo, buildInfoValid = debug.ReadBuildInfo() | ||
| }) | ||
| if !buildInfoValid { | ||
| panic("couldn't read build info") | ||
| } | ||
| for _, setting := range buildInfo.Settings { | ||
| if setting.Key != key { | ||
| continue | ||
| } | ||
| return setting.Value, true | ||
| } | ||
| return "", false | ||
| } |
32 changes: 32 additions & 0 deletionscli/buildinfo/buildinfo_test.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| package buildinfo_test | ||
| import ( | ||
| "testing" | ||
| "github.com/stretchr/testify/require" | ||
| "golang.org/x/mod/semver" | ||
| "github.com/coder/coder/cli/buildinfo" | ||
| ) | ||
| func TestBuildInfo(t *testing.T) { | ||
| t.Parallel() | ||
| t.Run("Version", func(t *testing.T) { | ||
| t.Parallel() | ||
| version := buildinfo.Version() | ||
| require.True(t, semver.IsValid(version)) | ||
| prerelease := semver.Prerelease(version) | ||
| require.Equal(t, "-devel", prerelease) | ||
| require.Equal(t, "v0", semver.Major(version)) | ||
| }) | ||
| t.Run("ExternalURL", func(t *testing.T) { | ||
| t.Parallel() | ||
| require.Equal(t, "https://github.com/coder/coder", buildinfo.ExternalURL()) | ||
| }) | ||
| // Tests don't include Go build info. | ||
| t.Run("NoTime", func(t *testing.T) { | ||
| t.Parallel() | ||
| _, valid := buildinfo.Time() | ||
| require.False(t, valid) | ||
| }) | ||
| } |
15 changes: 15 additions & 0 deletionscli/root.go
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
2 changes: 1 addition & 1 deletiongo.mod
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
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.