gitscm

Documentation

Overview

Refer to: - https://github.com/src-d/go-git - https://github.com/src-d/go-git/blob/master/_examples/clone/main.go"

Index

• Variables
• type Client
  • func New(optFns ...GitClientOptFn) (*Client, error)
  • func (client *Client) Clone(url, directory string) error
• type GitClientOptFn
  • func CloneOptRecursionSubmodulesDepth(resursiveDepth int) GitClientOptFn
  • func CloneOptStateReader(reader io.Reader) GitClientOptFn
  • func CloneOptsCommitsLimit(limitDepth int) GitClientOptFn
  • func CloneOptsReferenceName(refName string) GitClientOptFn
  • func CloneOptsSingleBranchOnly(singleBranch bool) GitClientOptFn
• type Interface

Variables

var (
	ErrNilPointer error = errors.New("client is nil")

	ErrRepoURLNotSpecified       error = errors.New("URL not specified")
	ErrRepoDirectoryNotSpecified error = errors.New("Local directory not specified")
)

Types

type Client

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

func New

func New(optFns ...GitClientOptFn) (*Client, error)

func (*Client) Clone

func (client *Client) Clone(url, directory string) error

type GitClientOptFn

type GitClientOptFn func(*Client) error

func CloneOptRecursionSubmodulesDepth

func CloneOptRecursionSubmodulesDepth(resursiveDepth int) GitClientOptFn

func CloneOptStateReader

func CloneOptStateReader(reader io.Reader) GitClientOptFn

func CloneOptsCommitsLimit

func CloneOptsCommitsLimit(limitDepth int) GitClientOptFn

Limit commits number

func CloneOptsReferenceName

func CloneOptsReferenceName(refName string) GitClientOptFn

Branch, Tag, commit Hash to clone, default is master/HEAD

func CloneOptsSingleBranchOnly

func CloneOptsSingleBranchOnly(singleBranch bool) GitClientOptFn

If true, only clone single branch

type Interface

type Interface interface {
	Clone(url, directory string) error
}