upgrade

Documentation

Overview

Package upgrade downloads and compares releases, and upgrades the running binary.

Index

• Constants
• Variables
• func To(rel Release) error
• func ToURL(url string) error
• type Asset
• type Relation
  • func CompareVersions(a, b string) Relation
• type Release
  • func LatestRelease(prerelease bool) (Release, error)

Constants

const (
	MajorOlder Relation = -2 // Older by a major version (x in x.y.z or 0.x.y).
	Older               = -1 // Older by a minor version (y or z in x.y.z, or y in 0.x.y)
	Equal               = 0  // Versions are semantically equal
	Newer               = 1  // Newer by a minor version (y or z in x.y.z, or y in 0.x.y)
	MajorNewer          = 2  // Newer by a major version (x in x.y.z or 0.x.y).
)

Variables

var (
	ErrVersionUpToDate    = errors.New("current version is up to date")
	ErrVersionUnknown     = errors.New("couldn't fetch release information")
	ErrUpgradeUnsupported = errors.New("upgrade unsupported")
	ErrUpgradeInProgress  = errors.New("upgrade already in progress")
)

Functions

func To

func To(rel Release) error

A wrapper around actual implementations

func ToURL

func ToURL(url string) error

A wrapper around actual implementations

Types

type Asset

type Asset struct {
	URL  string `json:"url"`
	Name string `json:"name"`
}

type Relation

type Relation int

func CompareVersions

func CompareVersions(a, b string) Relation

Returns a relation describing how a compares to b.

type Release

type Release struct {
	Tag        string  `json:"tag_name"`
	Prerelease bool    `json:"prerelease"`
	Assets     []Asset `json:"assets"`
}

func LatestRelease

func LatestRelease(prerelease bool) (Release, error)

Returns the latest release, including prereleases or not depending on the argument