Documentation ¶
Overview ¶
The version command can be just added to your Cobra root command. At build time, the variables name, version, Commit, and BuildTags can be passed as build flags as shown in the following example:
go build -X "github.com/ver13/ava/pkg/common/version.name=Golang Microservices Framework" \ -X "github.com/ver13/ava/pkg/common/version.ServerName=avaServer" \ -X "github.com/ver13/ava/pkg/common/version.ClientName=avaCli" \ -X "github.com/ver13/ava/pkg/common/version.version=v1.0.0" \ -X "github.com/ver13/ava/pkg/common/version.Commit=f0f7b7dab7e36c20b757cebce0e8f4fc5b95de60" \ -X "github.com/ver13/ava/pkg/common/version.BuildTags=linux darwin amd64"
Index ¶
- Variables
- type VersionInfo
- func (v *VersionInfo) GetClientName() string
- func (v VersionInfo) GetGitCommit() string
- func (v *VersionInfo) GetGoVersion() string
- func (v *VersionInfo) GetName() string
- func (v *VersionInfo) GetSemanticVersion() *semver.Version
- func (v *VersionInfo) GetServerName() string
- func (v *VersionInfo) Major() int64
- func (v *VersionInfo) Metadata() string
- func (v *VersionInfo) Minor() int64
- func (v *VersionInfo) Patch() int64
- func (v *VersionInfo) Prerelease() semver.PreRelease
- func (v *VersionInfo) String() string
- type VersionInfoI
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // application's name Name = "" // server binary name ServerName = "<appd>" // client binary name ClientName = "<appcli>" // application's version Version string Release = "" // commit Commit = "" // hash of the go.sum file GoSumHash = "" // build tags BuildTags = "" BuildNumber = "" BuildDate = "" BuildHash = "" SemanticVersion = "" )
Functions ¶
This section is empty.
Types ¶
type VersionInfo ¶
type VersionInfo struct { Name string `json:"name"` ServerName string `json:"server_name"` ClientName string `json:"client_name"` GitCommit string `json:"commit"` SemanticVersion *semver.Version `json:"semantic_version"` GoVersion string `json:"go"` }
func GetInstance ¶
func GetInstance() (*VersionInfo, *errorAVA.Error)
func (*VersionInfo) GetClientName ¶
func (v *VersionInfo) GetClientName() string
func (VersionInfo) GetGitCommit ¶
func (v VersionInfo) GetGitCommit() string
func (*VersionInfo) GetGoVersion ¶
func (v *VersionInfo) GetGoVersion() string
func (*VersionInfo) GetName ¶
func (v *VersionInfo) GetName() string
func (*VersionInfo) GetSemanticVersion ¶
func (v *VersionInfo) GetSemanticVersion() *semver.Version
func (*VersionInfo) GetServerName ¶
func (v *VersionInfo) GetServerName() string
func (*VersionInfo) Major ¶
func (v *VersionInfo) Major() int64
func (*VersionInfo) Metadata ¶
func (v *VersionInfo) Metadata() string
func (*VersionInfo) Minor ¶
func (v *VersionInfo) Minor() int64
func (*VersionInfo) Patch ¶
func (v *VersionInfo) Patch() int64
func (*VersionInfo) Prerelease ¶
func (v *VersionInfo) Prerelease() semver.PreRelease
func (*VersionInfo) String ¶
func (v *VersionInfo) String() string
Click to show internal directories.
Click to hide internal directories.