version

Documentation

Overview

Package version holds some version data common to patcher client and server. Most of these values will be inserted at build time with `-ldFlags` directives for official builds.

Index

• Variables
• func GetVersionInfo() string
• func ShortVersion() string
• type BuildVersionInfo
  • func (b BuildVersionInfo) GetVersionDate() time.Time

Variables

var (
	OfficialBuild string
	BuildBranch   string
	VersionDate   string
	VersionSHA    string
	VersionNumber string

	// BuildVersion holds the build details
	BuildVersion = BuildVersionInfo{
		Version:       VersionNumber,
		OfficialBuild: OfficialBuild,
		BuildBranch:   BuildBranch,
		VersionDate:   VersionDate,
		VersionSHA:    VersionSHA,
	}
)

Functions

func GetVersionInfo

func GetVersionInfo() string

GetVersionInfo returns a string representing the version information for the current binary.

func ShortVersion

func ShortVersion() string

ShortVersion returns a short build string, such as "2.0.0-dev"

Types

type BuildVersionInfo

type BuildVersionInfo struct {
	// Version number for official releases Updated manually before each release.
	Version string
	// Set to any non-empty value by official release script
	OfficialBuild string
	//Set the branch name that we are building here
	BuildBranch string
	// VersionDate Date and time of build. Should be in YYYYMMDDHHMMSS format
	VersionDate string
	// VersionSHA should be set at build time as the most recent commit hash.
	VersionSHA string
}

func (BuildVersionInfo) GetVersionDate

func (b BuildVersionInfo) GetVersionDate() time.Time

GetVersionDate returns a go time var from the time string