git

Documentation

Index

• func Clone(ctx context.Context, dir string, options CloneOptions) (string, error)
• func IsClean(path string) (bool, error)
• func Pull(path string, options PullOptions) error
• type CloneOptions
• type PullOptions

Functions

func Clone

func Clone(ctx context.Context, dir string, options CloneOptions) (string, error)

Clone clones the repository with the given [options] into [dir]. Returns the checked out hash.

func IsClean

func IsClean(path string) (bool, error)

func Pull

func Pull(path string, options PullOptions) error

Types

type CloneOptions

type CloneOptions struct {
	URL string
	// Order of preference: hash > branch > tag.
	Hash         string
	Branch       string
	Tag          string
	SingleBranch bool
	Depth        int
	SSHPath      string
}

type PullOptions

type PullOptions struct {
	SSHPath string
}