version

Documentation

Overview

Package version is a convenience utility that provides interop-node 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/settlus/chain/tools/interop-node/version.Name=gaia \
 -X github.com/settlus/chain/tools/interop-node/version.AppName=gaiad \
 -X github.com/settlus/chain/tools/interop-node/version.Version=1.0 \
 -X github.com/settlus/chain/tools/interop-node/version.Commit=f0f7b7dab7e36c20b757cebce0e8f4fc5b95de60 \
 -X "github.com/settlus/chain/tools/interop-node/version.BuildTags=linux darwin amd64"

Index

• Variables
• type ContextKey
• type ExtraInfo
• type Info
  • func NewInfo() Info
  • func (vi Info) String() string

Variables

var (
	// Name application's name
	Name = ""
	// AppName application binary name
	AppName = "<appd>"
	// Version application's version string
	Version = ""
	// Commit commit
	Commit = ""
	// BuildTags build tags
	BuildTags = ""
)

Types

type ContextKey

type ContextKey struct{}

ContextKey is used to store the ExtraInfo in the context.

type ExtraInfo

type ExtraInfo map[string]string

ExtraInfo contains a set of extra information provided by apps

type Info

type Info struct {
	Name      string     `json:"name" yaml:"name"`
	AppName   string     `json:"server_name" yaml:"server_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"`
	BuildDeps []buildDep `json:"build_deps" yaml:"build_deps"`
	ExtraInfo ExtraInfo  `json:"extra_info,omitempty" yaml:"extra_info,omitempty"`
}

Info defines the application version information.

func NewInfo

func NewInfo() Info

func (Info) String

func (vi Info) String() string