version

Documentation

Overview

Package version contains version and build variables set by the CI process.

Index

• Constants
• Variables
• func ClearRecentCheckCache() error
• func LogUpdate(ctx context.Context, update *Update)
• func String() string
• type CheckOption
  • func WithClient(client *http.Client) CheckOption
  • func WithReference(current semver.Version) CheckOption
  • func WithURLs(sourceURL, docsURL string) CheckOption
• type Update
  • func CheckUpdate(ctx context.Context, opts ...CheckOption) (*Update, error)

Constants

const TTSUpgradingDocsURL = "https://www.thethingsindustries.com/docs/getting-started/upgrading/"

TTSUpgradingDocsURL points to the upgrading documentation.

const TTSVersionCheckURL = "https://www.thethingsindustries.com/releases/thethingsstack-open-source.json"

TTSVersionCheckURL points to a list of The Things Stack releases that is used for version checking.

Variables

var BuildDate = ""

BuildDate of the binary

var GitCommit = ""

GitCommit from which the binary was built

var TTN = "3.20.0-dev"

TTN Version

Functions

func ClearRecentCheckCache

func ClearRecentCheckCache() error

ClearRecentCheckCache clears cache

func LogUpdate

func LogUpdate(ctx context.Context, update *Update)

LogUpdate logs an Warn level message when there is a newer minor, and a Log level message when there is a newer patch. When there is no new minor or patch version, this function does nothing.

func String

func String() string

String returns the version string.

Types

type CheckOption

type CheckOption interface {
	// contains filtered or unexported methods
}

CheckOption customizes the version check.

func WithClient

func WithClient(client *http.Client) CheckOption

WithClient configures a custom HTTP client.

func WithReference

func WithReference(current semver.Version) CheckOption

WithReference configures a custom reference version.

func WithURLs

func WithURLs(sourceURL, docsURL string) CheckOption

WithURLs configures custom URLs for source and documentation.

type Update

type Update struct {
	Current,
	Latest semver.Version
	DocsURL      string
	Minor, Patch bool
}

Update is the latest version.

func CheckUpdate

func CheckUpdate(ctx context.Context, opts ...CheckOption) (*Update, error)

CheckUpdate checks whether there is a version update available. If there is no update, or no new version is available, this function returns nil. The function uses cache.