version

Documentation

Index

• type CheckResult
  • func Check(currentVersion string) *CheckResult
  • func (r *CheckResult) NoticeMessage() string

Types

type CheckResult

type CheckResult struct {
	Current string
	Latest  string
}

CheckResult is returned when a newer version is available.

func Check

func Check(currentVersion string) *CheckResult

Check compares the running version against the latest GitHub release. Returns nil if the version is current, the check was performed recently, or anything goes wrong (version checks should never block the user).

func (*CheckResult) NoticeMessage

func (r *CheckResult) NoticeMessage() string

NoticeMessage returns a user-friendly upgrade notice.