version

README

version

Package version provides a single location to house the version information for dcrstakepool and other utilities provided in the same repository.

Installation and Updating

This package is internal and therefore is neither directly installed nor needs to be manually updated.

License

Package version is licensed under the copyfree ISC License.

Documentation

Overview

Package version provides a single location to house the version information for dcrstakepool and other utilities provided in the same repository.

Index

• Constants
• Variables
• func NormalizeBuildString(str string) string
• func NormalizePreRelString(str string) string
• func String() string

Constants

const (
	Major uint = 1
	Minor uint = 4
	Patch uint = 0
)

These constants define the application version and follow the semantic versioning 2.0.0 spec (http://semver.org/).

Variables

var (
	// PreRelease is defined as a variable so it can be overridden during the
	// build process with:
	// '-ldflags "-X github.com/decred/dcrstakepool/internal/version.PreRelease=foo"'
	// if needed.  It MUST only contain characters from semanticAlphabet per
	// the semantic versioning spec.
	PreRelease = "pre"

	// BuildMetadata is defined as a variable so it can be overridden during the
	// build process with:
	// '-ldflags "-X github.com/decred/dcrstakepool/internal/version.BuildMetadata=foo"'
	// if needed.  It MUST only contain characters from semanticBuildAlphabet
	// per the semantic versioning spec.
	BuildMetadata = "dev"
)

Functions

func NormalizeBuildString

func NormalizeBuildString(str string) string

NormalizeBuildString returns the passed string stripped of all characters which are not valid according to the semantic versioning guidelines for build metadata strings. In particular they MUST only contain characters in semanticBuildAlphabet.

func NormalizePreRelString

func NormalizePreRelString(str string) string

NormalizePreRelString returns the passed string stripped of all characters which are not valid according to the semantic versioning guidelines for pre-release strings. In particular they MUST only contain characters in semanticAlphabet.

func String

func String() string

String returns the application version as a properly formed string per the semantic versioning 2.0.0 spec (http://semver.org/).