updatecheck

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

type Comparison struct {
	// Status is identical, ahead (the branch has moved on), behind (the build
	// is ahead of the branch) or diverged.
	Status string
	// BehindBy is how many commits the branch is ahead of this build.
	BehindBy int
	URL      string
	// CheckedAt is when the comparison was made.
	CheckedAt time.Time
}

type ComponentStatus struct {
	Name           string
	CurrentVersion string
	// CurrentCommit is the short commit the component was built from, empty
	// when it reported none.
	CurrentCommit string
	LatestVersion string
	State         string
	// Channel is how State was reached: ChannelRelease or ChannelCommit.
	// Empty when neither comparison could be made.
	Channel     string
	ReleaseURL  string
	PublishedAt *time.Time
	// BehindBy is how many commits behind the tracked branch this build is,
	// set only on ChannelCommit.
	BehindBy int
	// CompareURL is the GitHub comparison between this build and the branch
	// head, set only on ChannelCommit.
	CompareURL string
}

type Config struct {
	// Enabled is false when the deployment opted out of the check; a disabled
	// Checker performs no outbound request and reports StateUnknown.
	Enabled bool
	// Interval between checks. Zero or less disables the periodic refresh,
	// leaving only the check performed at startup.
	Interval time.Duration
	// APIRepo and FrontendRepo are "owner/name" GitHub repository paths.
	APIRepo      string
	FrontendRepo string
	// Branch is the branch the :latest images are built from; commit
	// comparisons are made against its head.
	Branch string
	// APIVersion is the running version of this binary.
	APIVersion string
	// APICommit is the commit this binary was built from, empty when unstamped.
	APICommit string
	// BaseURL is the GitHub API root.
	BaseURL string
	// HTTPClient performs the release lookups.
	HTTPClient *http.Client
}

type Release struct {
	Version     string
	URL         string
	PublishedAt time.Time
}

type Status struct {
	Enabled bool
	// UpdateAvailable is true when any component is behind its newest
	// published release.
	UpdateAvailable bool
	LastCheckedAt   *time.Time
	// LastError is a coarse reason for the last failed check, empty when the
	// last check succeeded or none has run.
	LastError string
	// Branch is the branch commit comparisons are made against.
	Branch     string
	Components []ComponentStatus
}