updater

Documentation

Index

• func CheckForUpdates(currentVersion string) error
• func CheckForUpdatesAsync(currentVersion string) <-chan *UpdateResult
• func PrintUpdateNotice(result *UpdateResult)
• type GitHubRelease
• type UpdateResult

Functions

func CheckForUpdates

func CheckForUpdates(currentVersion string) error

CheckForUpdates checks if a new version is available (blocking, with prompt)

func CheckForUpdatesAsync

func CheckForUpdatesAsync(currentVersion string) <-chan *UpdateResult

CheckForUpdatesAsync checks for updates in the background and returns a channel

func PrintUpdateNotice

func PrintUpdateNotice(result *UpdateResult)

PrintUpdateNotice prints an update notice if available

Types

type GitHubRelease

type GitHubRelease struct {
	TagName string `json:"tag_name"`
	HTMLURL string `json:"html_url"`
}

GitHubRelease represents a GitHub release

type UpdateResult

type UpdateResult struct {
	Available      bool
	CurrentVersion string
	LatestVersion  string
}

UpdateResult holds the result of an async update check