installer

Documentation

Index

• type Installer
  • func New(releasesDir releases.Dir, bucket releasebucket.ReleaseBucket, ...) Installer
• type Options
• type ResolvedVersions
  • func (v ResolvedVersions) UpdateNeeded() bool

Types

type Installer

type Installer interface {
	// ResolveVersions expand a version or tag to a canonical Thelma version and identify
	// the currently-installed Thelma version
	ResolveVersions(versionOrTag string) (ResolvedVersions, error)
	// UpdateThelma perform a Thelma update, obtaining a file lock first so multiple processes don't
	// step on each other
	UpdateThelma(versionOrTag string) error
}

func New

func New(releasesDir releases.Dir, bucket releasebucket.ReleaseBucket, options ...func(*Options)) Installer

type Options

type Options struct {
	// KeepReleases number of old releases to keep in ~/.thelma/releases directory
	KeepReleases int
}

type ResolvedVersions

type ResolvedVersions struct {
	// VersionAlias tag or version string that was resolved (eg. "latest", "1.2.3", "v1.2.3")
	VersionAlias string
	// TargetVersion the resolved canonical version of Thelma that should be installed (eg. "v1.2.3")
	TargetVersion string
	// CurrentVersion locally-installed version of Thelma; may be "" if this is
	// a bootstrap/fresh install
	CurrentVersion string
}

ResolvedVersions contains resolved version information for Thelma releases

func (ResolvedVersions) UpdateNeeded

func (v ResolvedVersions) UpdateNeeded() bool

UpdateNeeded return true if Thelma should be updated