git

Documentation

Index

• Constants
• type CloneOptions
• type Options
• type Ref
• type Repository
  • func NewRepo(repoURL *url.URL, opts *Options) *Repository
  • func (r *Repository) Clone(ctx context.Context, ref string, opts *CloneOptions) (fs.FS, error)
  • func (r *Repository) Fetch(ctx context.Context, w io.Writer, file, ref string) error

Constants

const HEAD = "HEAD"

Types

type CloneOptions

type CloneOptions struct {
	SparseFilter []string
}

/ CloneOptions to tune the behavior of git clone.

type Options

type Options struct {
	IsFSBacked        bool
	Dir               string
	ResolveExactTag   bool
	RecurseSubModules bool // TODO
	AllowPreReleases  bool
	Debug             bool
	GitSkipAutoDetect bool
}

Options for a git Repository

type Ref

type Ref struct {
	*plumbing.Reference

	ShortName string
	IsTag     bool
	IsSemver  bool
	Version   semver.Version
}

Ref wraps a git plumbing.Reference.

type Repository

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

Repository is a git repo.

func NewRepo

func NewRepo(repoURL *url.URL, opts *Options) *Repository

NewRepo initializes a new git repository for a given URL.

No resources are actually fetched or stored yet.

func (*Repository) Clone

func (r *Repository) Clone(ctx context.Context, ref string, opts *CloneOptions) (fs.FS, error)

Clone the repository defined by an URL.

func (*Repository) Fetch

func (r *Repository) Fetch(ctx context.Context, w io.Writer, file, ref string) error

Fetch a file at a given ref from the Repository.

The file is copied to the given io.Writer.