version

Documentation

Overview

Package version provides build-time version variables. Set these via -ldflags at build time:

go build -ldflags "-X github.com/hatami57/microjet/core/version.Version=1.2.3 \
    -X github.com/hatami57/microjet/core/version.CommitHash=$(git rev-parse --short HEAD) \
    -X github.com/hatami57/microjet/core/version.BuildTime=$(date -u +%Y-%m-%dT%H:%M:%SZ)"

Index

• Variables
• func GoVersion() string
• func Print()
• func String() string
• type Info
  • func Get() Info
  • func (i Info) Print(w io.Writer)
  • func (i Info) PrintToStdout()

Variables

var (
	Version    = "dev"
	CommitHash = "unknown"
	BuildTime  = "unknown"
)

Functions

func GoVersion

func GoVersion() string

GoVersion reports the Go toolchain that built the binary. It is authoritative at runtime, so unlike Version/CommitHash/BuildTime it is not set via ldflags.

func Print

func Print()

func String

func String() string

Types

type Info

type Info struct {
	Version    string `json:"version"`
	CommitHash string `json:"commit_hash"`
	BuildTime  string `json:"build_time"`
	GoVersion  string `json:"go_version"`
}

Info holds all version fields as a value type for structured access or logging.

func Get

func Get() Info

Get returns the current build's version info.

func (Info) Print

func (i Info) Print(w io.Writer)

Print writes version fields as key=value lines to w.

func (Info) PrintToStdout

func (i Info) PrintToStdout()

PrintToStdout writes version fields as key=value lines to stdout.