version

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/line/lbm-sdk/version.Name=gaia \
 -X github.com/line/lbm-sdk/version.AppName=gaiad \
 -X github.com/line/lbm-sdk/version.Version=1.0 \
 -X github.com/line/lbm-sdk/version.Commit=f0f7b7dab7e36c20b757cebce0e8f4fc5b95de60 \
 -X "github.com/line/lbm-sdk/version.BuildTags=linux darwin amd64"

Index

• Variables
• func NewVersionCommand() *cobra.Command
• type Info
  • func NewInfo() Info
  • func (vi Info) String() string

Variables

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

Functions

func NewVersionCommand

func NewVersionCommand() *cobra.Command

NewVersionCommand returns a CLI command to interactively print the application binary version information.

Types

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"`
	LbmSdkVersion string     `json:"lbm_sdk_version" yaml:"lbm_sdk_version"`
}

Info defines the application version information.

func NewInfo

func NewInfo() Info

func (Info) String

func (vi Info) String() string