git

Documentation

Index

• func NewManager(conf *Conf) (*manager, error)
• func NewTarget(conf *Conf, opts ...gitCloneTargetOption) (*gitCloneTarget, error)
• func WithClock(clock clockwork.Clock) gitCloneTargetOption
• func WithCloner(cloner Cloner) gitCloneTargetOption
• func WithFS(fs billy.Filesystem) gitCloneTargetOption
• type Cloner
• type Conf
  • func NewConf(envLoader env.Loader) (*Conf, error)
• type ConfAuth
• type Repository

Functions

func NewManager

func NewManager(conf *Conf) (*manager, error)

NewManager returns a new default clone manager.

func NewTarget

func NewTarget(conf *Conf, opts ...gitCloneTargetOption) (*gitCloneTarget, error)

NewTarget returns a new git clone target.

func WithClock

func WithClock(clock clockwork.Clock) gitCloneTargetOption

WithClock allows customising the default clock. Mainly used for testing.

func WithCloner

func WithCloner(cloner Cloner) gitCloneTargetOption

WithCloner allows customising the default cloner. Mainly used for testing.

func WithFS

func WithFS(fs billy.Filesystem) gitCloneTargetOption

WithFS allows customising the default filesystem manager. Mainly used for testing.

Types

type Cloner

type Cloner interface {
	Clone(ctx context.Context) (*Repository, error)
}

Cloner is the contract for cloning repositories.

type Conf

type Conf struct {
	ClonePath string
	RepoURL   string
	Reference string

	ConfAuth ConfAuth
}

Conf wraps the component configuration.

func NewConf

func NewConf(envLoader env.Loader) (*Conf, error)

NewConf returns a new configuration build from environment lookup.

type ConfAuth

type ConfAuth struct {
	Username    string
	AuthEnabled bool
	AccessToken string
}

ConfAuth contains authentication configuration.

type Repository

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

Repository wraps a git repository to not leak deps.