cloner

Documentation

Overview

Package cloner provides support for cloning git repositories.

Index

• type Cloner
  • func Default() Cloner
• type Params

Types

type Cloner

type Cloner interface {
	// Clone a repository.
	Clone(context.Context, Params) error
}

Cloner clones a repository.

func Default

func Default() Cloner

Default returns the default cloner which relies on the os/exec package to clone a repository using the git binary installed on the host.

type Params

type Params struct {
	Repo string
	Ref  string
	Sha  string
	Dir  string // Target clone directory.

	// clone credentials (not yet implemented)
	Username   string
	Password   string
	Privatekey string
}

Params provides clone params.