Files
pki/Documentation/api/internal_version.md

2.9 KiB

version

import "github.com/effective-security/xpki/internal/version"

Package version exposes the build version of the binaries. The version is set by the linker (-X ...internal/version.build=<version>, as make build does with GIT_VERSION) and otherwise read from the module build information, so a plain go build or go install reports its module version or VCS revision. PopulateFromBuild parses "[v]major.minor.commit[-dirty]".

Index

type Info

Info describes a version of an executable

type Info struct {
    Major   uint   `json:"major"`
    Minor   uint   `json:"minor"`
    Commit  uint   `json:"commi"`
    Build   string `json:"build"`
    Runtime string `json:"runtime"`
    // contains filtered or unexported fields
}

func Current

func Current() Info

Current returns the current version [set by the build]

func (Info) Float

func (v Info) Float() float32

Float returns the version Major/Minor as a float Major.Minor e.g. given Major:3 Minor:52001, it'll return 3.52001 this is only valid if PopulateFromBuild has been called.

func (Info) GreaterOrEqual

func (v Info) GreaterOrEqual(than Info) bool

GreaterOrEqual returns true if the version 'v' is the same or new that the supplied parameter 'other' This only examines the Major & Minor field (as the SHA in Build provides no ordering indication)

func (*Info) PopulateFromBuild

func (v *Info) PopulateFromBuild()

PopulateFromBuild parses the major, minor and commit values from Build, which is expected in the format [v]major.minor.commit[-dirty]; make build links it in from GIT_VERSION (see current.go). Values that do not match stay zero.

func (Info) String

func (v Info) String() string

Generated by gomarkdoc