updatecheck

Documentation

Index

• Constants
• func MaybeNotify(ctx context.Context, w io.Writer, options Options)
• type Options
• type Result
  • func CheckLatest(ctx context.Context, options Options) (*Result, error)
  • func SelfUpdate(ctx context.Context, targetPath string, options Options) (*Result, error)
  • func (r Result) Notice() string
  • func (r Result) ReleasePage() string

Constants

const (
	DefaultLatestReleaseURL = "https://api.github.com/repos/Colvin-Y/kubernetes-ontology/releases/latest"
	DefaultAutoCheckTimeout = 1500 * time.Millisecond

	EnvLatestReleaseURL = "KUBERNETES_ONTOLOGY_UPDATE_URL"
	EnvSkipAutoCheck    = "KUBERNETES_ONTOLOGY_SKIP_UPDATE_CHECK"
)

Functions

func MaybeNotify

func MaybeNotify(ctx context.Context, w io.Writer, options Options)

Types

type Options

type Options struct {
	CurrentVersion   string
	BinaryName       string
	GOOS             string
	GOARCH           string
	LatestReleaseURL string
	Client           *http.Client
}

type Result

type Result struct {
	CurrentVersion  string
	LatestVersion   string
	ReleaseURL      string
	AssetName       string
	AssetURL        string
	UpdateAvailable bool
	Comparable      bool
	UpdatedPath     string
	Staged          bool
}

func CheckLatest

func CheckLatest(ctx context.Context, options Options) (*Result, error)

func SelfUpdate

func SelfUpdate(ctx context.Context, targetPath string, options Options) (*Result, error)

func (Result) Notice

func (r Result) Notice() string

func (Result) ReleasePage

func (r Result) ReleasePage() string