sourceproviders

Documentation

Index

• Variables
• type GitSourceProvider
  • func GetGitSourceProvider(ctx context.Context, remote, directory, version string) (*GitSourceProvider, error)
  • func NewGitSourceProvider(remote, directory, version string) *GitSourceProvider
  • func (g *GitSourceProvider) Cleanup(ctx context.Context)
  • func (g *GitSourceProvider) Get(ctx context.Context, opts ...entity.GetOption) (string, error)
  • func (g *GitSourceProvider) Type() constant.SourceProviderType

Variables

var (
	ErrCheckingOutBranch     = errors.New("err checking out branch")
	ErrCheckingOutRevision   = errors.New("err checking out revision")
	ErrCheckingOutRepository = errors.New("err checking out repository")
)

Types

type GitSourceProvider

type GitSourceProvider struct {
	// The remote URL of the git repository
	Remote string
	// The directory to clone the git repository
	Directory string
	// The version of the git repository
	Version string
}

GitSourceProvider is the implementation of the SourceProvider interface

func GetGitSourceProvider

func GetGitSourceProvider(ctx context.Context, remote, directory, version string) (*GitSourceProvider, error)

GetGitSourceProvider returns a GitSourceProvider

func NewGitSourceProvider

func NewGitSourceProvider(remote, directory, version string) *GitSourceProvider

NewGitSourceProvider creates a new GitSourceProvider

func (*GitSourceProvider) Cleanup

func (g *GitSourceProvider) Cleanup(ctx context.Context)

Cleanup cleans up the resources of the provider

func (*GitSourceProvider) Get

func (g *GitSourceProvider) Get(ctx context.Context, opts ...entity.GetOption) (string, error)

Get clones the git repository and returns the directory

func (*GitSourceProvider) Type

func (g *GitSourceProvider) Type() constant.SourceProviderType

Type returns the type of the source provider