update

Documentation

Index

• func Check(ctx context.Context, currentVersion string, cliVersioner Versioner) (current, latest semver.Version, shouldUpdate bool, err error)
• func CheckAsync(ctx context.Context, file config.File, configFilePath string, ...) (printResults func(io.Writer))
• type GitHub
  • func NewGitHub(ctx context.Context, org string, repo string, binary string) *GitHub
  • func (g GitHub) Download(ctx context.Context, version semver.Version) (filename string, err error)
  • func (g GitHub) LatestVersion(ctx context.Context) (semver.Version, error)
  • func (g *GitHub) RenameLocalBinary(s string) error
• type RootCommand
  • func NewRootCommand(parent common.Registerer, configFilePath string, cliVersioner Versioner, ...) *RootCommand
  • func (c *RootCommand) Exec(in io.Reader, out io.Writer) error
• type Versioner

Functions

func Check

func Check(ctx context.Context, currentVersion string, cliVersioner Versioner) (current, latest semver.Version, shouldUpdate bool, err error)

Check if the CLI can be updated.

func CheckAsync

func CheckAsync(ctx context.Context, file config.File, configFilePath string, currentVersion string, cliVersioner Versioner) (printResults func(io.Writer))

CheckAsync is a helper function for Check. If the app config's LastChecked time has past the specified TTL, launch a goroutine to perform the Check using the provided context. Return a function that will print an informative message to the writer if there is a newer version available.

Callers should invoke CheckAsync via

f := CheckAsync(...)
defer f()

Types

type GitHub

type GitHub struct {
	// contains filtered or unexported fields
}

GitHub is a versioner that uses GitHub releases.

func NewGitHub

func NewGitHub(ctx context.Context, org string, repo string, binary string) *GitHub

NewGitHub returns a usable GitHub versioner utilizing the provided token.

func (GitHub) Download

func (g GitHub) Download(ctx context.Context, version semver.Version) (filename string, err error)

Download implements the Versioner interface.

func (GitHub) LatestVersion

func (g GitHub) LatestVersion(ctx context.Context) (semver.Version, error)

LatestVersion implements the Versioner interface.

func (*GitHub) RenameLocalBinary

func (g *GitHub) RenameLocalBinary(s string) error

RenameLocalBinary will rename the downloaded binary.

NOTE: this exists so that we can, for example, rename a binary such as 'viceroy' to something less ambiguous like 'fastly-localtesting'.

type RootCommand

type RootCommand struct {
	common.Base
	// contains filtered or unexported fields
}

RootCommand is the parent command for all subcommands in this package. It should be installed under the primary root command.

func NewRootCommand

func NewRootCommand(parent common.Registerer, configFilePath string, cliVersioner Versioner, client api.HTTPClient, globals *config.Data) *RootCommand

NewRootCommand returns a new command registered in the parent.

func (*RootCommand) Exec

func (c *RootCommand) Exec(in io.Reader, out io.Writer) error

Exec implements the command interface.

type Versioner

type Versioner interface {
	LatestVersion(context.Context) (semver.Version, error)
	Download(context.Context, semver.Version) (filename string, err error)
}

Versioner describes a source of CLI release artifacts.