update

Documentation

Index

• Constants
• func CheckForUpdate(version string, logF func(i ...interface{}))
• type LatestRelease
• type Store

Constants

const (
	// AtlasNoUpdateNotifier when enabled it cancels checking for update
	AtlasNoUpdateNotifier = "ATLAS_NO_UPDATE_NOTIFIER"
)

Functions

func CheckForUpdate

func CheckForUpdate(version string, logF func(i ...interface{}))

CheckForUpdate implements a notification to the user when a later release is available 1. Check release file ~/.atlas/release.json for latest known release and poll time 2. If last poll was more than 24h, poll GitHub public API https://docs.github.com/en/rest/reference/releases#get-the-latest-release 3. Store the latest release metadata 4. If current build Version, that is not development, is lower than the latest release, notify user

Types

type LatestRelease

type LatestRelease struct {
	Version string `json:"tag_name"`
	URL     string `json:"html_url"`
}

LatestRelease holds the required fields from https://api.github.com/repos/ariga/atlas/releases/latest.

type Store

type Store struct {
	Version   string    `json:"version"`
	URL       string    `json:"url"`
	CheckedAt time.Time `json:"checkedat"`
}

Store is where the latest release data is stored on CLI host.