version

Documentation

Overview

Package version provides information about what Bacalhau was built from.

The bulk of the information comes from the debug.BuildInfo struct which gets automatically populated when building a binary as a Go module (`go build .` vs `go build main.go`) with Go 1.18+. It contains various things such as VCS information or dependencies.

Index

• Constants
• Variables
• func Get() *model.BuildVersionInfo

Constants

const DevelopmentGitVersion = "v0.0.0-xxxxxxx"

Variables

var (
	// GITVERSION is the Git tag that Bacalhau was built from. This is expected to be populated via the `ldflags` flag,
	// at least until https://github.com/golang/go/issues/50603 is fixed. The value shown here will be used when the
	// value isn't provided by ldflags.
	//
	// A good article on how to use buildflags is
	// https://www.digitalocean.com/community/tutorials/using-ldflags-to-set-version-information-for-go-applications.
	GITVERSION = DevelopmentGitVersion
)

Functions

func Get

func Get() *model.BuildVersionInfo

Get returns the overall codebase version. It's for detecting what code a binary was built from.