-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.go
180 lines (150 loc) · 4.36 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
//go:generate go run gen.go
//go:generate go fmt
package version
import (
"encoding/json"
"fmt"
"runtime"
"runtime/debug"
"time"
"gopkg.in/yaml.v3"
goversion "github.com/hashicorp/go-version"
git "github.com/elliotxx/gulu/gitutil"
)
var info = NewMainOrDefaultVersionInfo()
func NewMainOrDefaultVersionInfo() *Info {
v := NewDefaultVersionInfo()
if i, ok := debug.ReadBuildInfo(); ok {
mod := &i.Main
if mod.Replace != nil {
mod = mod.Replace
}
if mod.Version != "(devel)" {
v.ReleaseVersion = mod.Version
}
}
return v
}
func NewDefaultVersionInfo() *Info {
return &Info{
ReleaseVersion: "default-version",
BuildInfo: &BuildInfo{
GoVersion: runtime.Version(),
GOOS: runtime.GOOS,
GOARCH: runtime.GOARCH,
NumCPU: runtime.NumCPU(),
Compiler: runtime.Compiler,
BuildTime: time.Now().Format("2006-01-02 15:04:05"),
},
}
}
// Info contains versioning information.
// following attributes:
//
// ReleaseVersion - "vX.Y.Z-00000000" used to indicate the last release version,
// containing GitVersion and GitCommitShort.
type Info struct {
ReleaseVersion string `json:"releaseVersion" yaml:"releaseVersion"` // Such as "v1.2.3-3836f877"
GitInfo *GitInfo `json:"gitInfo,omitempty" yaml:"gitInfo,omitempty"`
BuildInfo *BuildInfo `json:"buildInfo,omitempty" yaml:"buildInfo,omitempty"`
}
// GitInfo contains git information.
// following attributes:
//
// LatestTag - "vX.Y.Z" used to indicate the last git tag.
// Commit - The git commit id corresponding to this source code.
// TreeState - "clean" indicates no changes since the git commit id
// "dirty" indicates source code changes after the git commit id
type GitInfo struct {
LatestTag string `json:"latestTag,omitempty" yaml:"latestTag,omitempty"` // Such as "v1.2.3"
Commit string `json:"commit,omitempty" yaml:"commit,omitempty"` // Such as "3836f8770ab8f488356b2129f42f2ae5c1134bb0"
TreeState string `json:"treeState,omitempty" yaml:"treeState,omitempty"` // Such as "clean", "dirty"
}
type BuildInfo struct {
GoVersion string `json:"goVersion,omitempty" yaml:"goVersion,omitempty"`
GOOS string `json:"GOOS,omitempty" yaml:"GOOS,omitempty"`
GOARCH string `json:"GOARCH,omitempty" yaml:"GOARCH,omitempty"`
NumCPU int `json:"numCPU,omitempty" yaml:"numCPU,omitempty"`
Compiler string `json:"compiler,omitempty" yaml:"compiler,omitempty"`
BuildTime string `json:"buildTime,omitempty" yaml:"buildTime,omitempty"` // Such as "2021-10-20 18:24:03"
}
func NewInfo() (*Info, error) {
var (
isHeadAtTag bool
headHash string
headHashShort string
latestTag string
gitVersion *goversion.Version
releaseVersion string
isDirty bool
gitTreeState string
err error
)
// Get git info
if headHash, err = git.GetHeadHash(); err != nil {
return nil, err
}
if headHashShort, err = git.GetHeadHashShort(); err != nil {
return nil, err
}
if latestTag, err = git.GetLatestTag(); err != nil {
return nil, err
}
if gitVersion, err = goversion.NewVersion(latestTag); err != nil {
return nil, err
}
if isHeadAtTag, err = git.IsHeadAtTag(latestTag); err != nil {
return nil, err
}
if isDirty, err = git.IsDirty(); err != nil {
return nil, err
}
// Get git tree state
if isDirty {
gitTreeState = "dirty"
} else {
gitTreeState = "clean"
}
// Get release version
if isHeadAtTag {
releaseVersion = gitVersion.Original()
} else {
releaseVersion = fmt.Sprintf("%s-%s", gitVersion.Original(), headHashShort)
}
return &Info{
ReleaseVersion: releaseVersion,
GitInfo: &GitInfo{
LatestTag: gitVersion.Original(),
Commit: headHash,
TreeState: gitTreeState,
},
BuildInfo: &BuildInfo{
GoVersion: runtime.Version(),
GOOS: runtime.GOOS,
GOARCH: runtime.GOARCH,
NumCPU: runtime.NumCPU(),
Compiler: runtime.Compiler,
BuildTime: time.Now().Format("2006-01-02 15:04:05"),
},
}, nil
}
func (v *Info) String() string {
return v.YAML()
}
func (v *Info) ShortString() string {
return fmt.Sprintf("%s; git: %s; build time: %s", v.ReleaseVersion, v.GitInfo.Commit, v.BuildInfo.BuildTime)
}
func (v *Info) JSON() string {
data, err := json.MarshalIndent(v, "", " ")
if err != nil {
return ""
}
return string(data)
}
func (v *Info) YAML() string {
data, err := yaml.Marshal(v)
if err != nil {
return ""
}
return string(data)
}