version

package

v1.0.0 Latest Latest Go to latest Published: May 14, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

Documentation ¶

Overview ¶

Package version is a convenience utility that provides SDK consumers with a ready-to-use version command that produces apps versioning information based on flags passed at compile time.

Configure the version command ¶

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/KiraCore/cosmos-sdk/version.Name=gaia \
 -X github.com/KiraCore/cosmos-sdk/version.ServerName=gaiad \
 -X github.com/KiraCore/cosmos-sdk/version.ClientName=gaiacli \
 -X github.com/KiraCore/cosmos-sdk/version.Version=1.0 \
 -X github.com/KiraCore/cosmos-sdk/version.Commit=f0f7b7dab7e36c20b757cebce0e8f4fc5b95de60 \
 -X "github.com/KiraCore/cosmos-sdk/version.BuildTags=linux darwin amd64"

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 string
	Version = ""
	// commit
	Commit = ""
	// build tags
	BuildTags = ""
)

View Source

var Cmd = &cobra.Command{
	Use:   "version",
	Short: "Print the app version",
	RunE:  runVersionCmd,
}

Cmd prints out the application's version information passed via build flags.

Functions ¶

This section is empty.

Types ¶

type Info ¶ added in v1.0.0

type Info struct {
	Name       string `json:"name" yaml:"name"`
	ServerName string `json:"server_name" yaml:"server_name"`
	ClientName string `json:"client_name" yaml:"client_name"`
	Version    string `json:"version" yaml:"version"`
	GitCommit  string `json:"commit" yaml:"commit"`
	BuildTags  string `json:"build_tags" yaml:"build_tags"`
	GoVersion  string `json:"go" yaml:"go"`
}

Info defines the application version information.

func NewInfo ¶ added in v1.0.0

func NewInfo() Info

func (Info) String ¶ added in v1.0.0

func (vi Info) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL