versioninfo

README

versioninfo

Importable package that parses debug.ReadBuildInfo() for inclusion in your Go application.

Requires Go 1.18+ for Git revision information, but compatible with prior versions of Go.

Examples

package main

import (
    "fmt"

    "github.com/carlmjohnson/versioninfo"
)

func main() {
    fmt.Println("Version:", versioninfo.Version)
    fmt.Println("Revision:", versioninfo.Revision)
    fmt.Println("DirtyBuild:", versioninfo.DirtyBuild)
    fmt.Println("LastCommit:", versioninfo.LastCommit)
}

You may use the concatenated information provided by versioninfo.Short():

package main

import (
    "fmt"

    "github.com/carlmjohnson/versioninfo"
)

func main() {
    fmt.Println("ShortInfo:", versioninfo.Short())
}

Add the -v and -version flags:

package main

import (
    "flag"
    "fmt"

    "github.com/carlmjohnson/versioninfo"
)

func main() {
    versioninfo.AddFlag(nil)
    flag.Parse()
    fmt.Println("done")
}

Documentation

Overview

Package versioninfo uses runtime.ReadBuildInfo() to set global executable revision information if possible.

Index

• Variables
• func AddFlag(f *flag.FlagSet)
• func Short() string

Variables

var (
	// Version will be the version tag if the binary is built with "go install url/tool@version".
	// If the binary is built some other way, it will be "(devel)".
	Version = "unknown"
	// Revision is taken from the vcs.revision tag in Go 1.18+.
	Revision = "unknown"
	// LastCommit is taken from the vcs.time tag in Go 1.18+.
	LastCommit time.Time
	// DirtyBuild is taken from the vcs.modified tag in Go 1.18+.
	DirtyBuild = true
)

Functions

func AddFlag

func AddFlag(f *flag.FlagSet)

AddFlag adds -v and -version flags to the FlagSet. If triggered, the flags print version information and call os.Exit(0). If FlagSet is nil, it adds the flags to flag.CommandLine.

func Short

func Short() string

Short provides a short string summarizing available version information.