git

Documentation

Overview

nolint: forbidigo

Index

• Constants
• func Available() bool
• type LocalRepository
  • func NewLocalRepository(ref model.TemplateRepository, fs filesystem.Fs) LocalRepository
  • func (v LocalRepository) CommitHash() string
  • func (v LocalRepository) Definition() model.TemplateRepository
  • func (v LocalRepository) Free() <-chan struct{}
  • func (v LocalRepository) Fs() (filesystem.Fs, RepositoryFsUnlockFn)
  • func (v LocalRepository) String() string
• type PullResult
• type RemoteRepository
  • func Checkout(ctx context.Context, ref model.TemplateRepository, sparse bool, ...) (r *RemoteRepository, err error)
  • func (r *RemoteRepository) CommitHash() string
  • func (r *RemoteRepository) Definition() model.TemplateRepository
  • func (r *RemoteRepository) Free() <-chan struct{}
  • func (r *RemoteRepository) Fs() (filesystem.Fs, RepositoryFsUnlockFn)
  • func (r *RemoteRepository) Load(ctx context.Context, path string) error
  • func (r *RemoteRepository) Pull(ctx context.Context) (*PullResult, error)
  • func (r *RemoteRepository) Ref() string
  • func (r *RemoteRepository) String() string
  • func (r *RemoteRepository) URL() string
  • func (r *RemoteRepository) WorkingFs() filesystem.Fs
• type Repository
• type RepositoryFsUnlockFn

Constants

const CommitHashNotSet = "-"

Functions

func Available

func Available() bool

Types

type LocalRepository

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

func NewLocalRepository

func NewLocalRepository(ref model.TemplateRepository, fs filesystem.Fs) LocalRepository

func (LocalRepository) CommitHash

func (v LocalRepository) CommitHash() string

func (LocalRepository) Definition

func (v LocalRepository) Definition() model.TemplateRepository

func (LocalRepository) Free

func (v LocalRepository) Free() <-chan struct{}

func (LocalRepository) Fs

func (v LocalRepository) Fs() (filesystem.Fs, RepositoryFsUnlockFn)

func (LocalRepository) String

func (v LocalRepository) String() string

type PullResult

type PullResult struct {
	OldHash string
	NewHash string
	Changed bool
}

type RemoteRepository

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

func Checkout

func Checkout(ctx context.Context, ref model.TemplateRepository, sparse bool, logger log.Logger) (r *RemoteRepository, err error)

func (*RemoteRepository) CommitHash

func (r *RemoteRepository) CommitHash() string

func (*RemoteRepository) Definition

func (r *RemoteRepository) Definition() model.TemplateRepository

func (*RemoteRepository) Free

func (r *RemoteRepository) Free() <-chan struct{}

func (*RemoteRepository) Fs

func (r *RemoteRepository) Fs() (filesystem.Fs, RepositoryFsUnlockFn)

Fs return repository filesystem.

func (*RemoteRepository) Load

func (r *RemoteRepository) Load(ctx context.Context, path string) error

Load a path from the remote git repository, if sparse mode is used.

func (*RemoteRepository) Pull

func (r *RemoteRepository) Pull(ctx context.Context) (*PullResult, error)

func (*RemoteRepository) Ref

func (r *RemoteRepository) Ref() string

Ref is Git branch or tag.

func (*RemoteRepository) String

func (r *RemoteRepository) String() string

func (*RemoteRepository) URL

func (r *RemoteRepository) URL() string

URL to Git repository.

func (*RemoteRepository) WorkingFs

func (r *RemoteRepository) WorkingFs() filesystem.Fs

type Repository

type Repository interface {
	String() string
	Definition() model.TemplateRepository
	CommitHash() string
	Fs() (filesystem.Fs, RepositoryFsUnlockFn)
}

type RepositoryFsUnlockFn

type RepositoryFsUnlockFn func()