github

Documentation

Overview

Package github implements the VersionResolver interface using Github as the backing version store. Both commits and tags are supported as a source of truth for the latest version of an application.

For tags, semantic version constructs are used. The latest semantic version is used. For commits, the latest commit in the default branch (determined through the Github API) is used.

See`detectVersion` for more information about the behaviour and how to select commits and tags for cases where both may be in use.

Index

• func New(b *box.Config) types.VersionResolver
• type VersionResolver
  • func (g *VersionResolver) GetLatestVersion(ctx context.Context, log logrus.FieldLogger, appName, applicationType string) (string, error)

Functions

func New

func New(b *box.Config) types.VersionResolver

New returns a new Github VersionResolver implementation

Types

type VersionResolver

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

VersionResolver implements the VersionResolver interface.

func (*VersionResolver) GetLatestVersion

func (g *VersionResolver) GetLatestVersion(ctx context.Context, log logrus.FieldLogger, appName, applicationType string) (string, error)

GetLatestVersion returns the latest image version based on git repo