version

README

version

Package version provides a single location to house the version information for dcrd 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 dcrlnlpd and other utilities provided in the same repository.

Index

• Variables
• func NormalizeString(str string) string
• func String() string

Variables

var (

	// Version is the application version per the semantic versioning 2.0.0 spec
	// (https://semver.org/).
	//
	// It is defined as a variable so it can be overridden during the build
	// process with:
	// '-ldflags "-X github.com/decred/dcrlnlpd/internal/version.Version=fullsemver"'
	// if needed.
	//
	// It MUST be a full semantic version per the semantic versioning spec or
	// the package will panic at runtime.  Of particular note is the pre-release
	// and build metadata portions MUST only contain characters from
	// semanticAlphabet.
	Version = "0.0.1-pre"

	// These fields are the individual semantic version components that define
	// the application version.
	Major         uint32
	Minor         uint32
	Patch         uint32
	PreRelease    string
	BuildMetadata string
)

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

Functions

func NormalizeString

func NormalizeString(str string) string

NormalizeString returns the passed string stripped of all characters which are not valid according to the semantic versioning guidelines for pre-release and build metadata 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 (https://semver.org/).