git

Documentation

Index

• Variables
• func Providers() []string
• type Auth
• type CloneOptions
  • func AddFlags(cmd *cobra.Command, bfs billy.Filesystem, prefix string) *CloneOptions
  • func (o *CloneOptions) Clone(ctx context.Context) (Repository, fs.FS, error)
  • func (o *CloneOptions) Parse()
  • func (o *CloneOptions) Path() string
  • func (o *CloneOptions) Revision() string
  • func (o *CloneOptions) URL() string
• type CreateRepoOptions
• type GetRepoOptions
• type Provider
  • func NewProvider(opts *ProviderOptions) (Provider, error)
• type ProviderOptions
• type PushOptions
• type Repository

Variables

var (
	ErrProviderNotSupported = errors.New("git provider not supported")
	ErrAuthenticationFailed = func(err error) error {
		return fmt.Errorf("authentication failed, make sure credentials are correct: %w", err)
	}
)

Errors

var (
	ErrNilOpts      = errors.New("options cannot be nil")
	ErrNoParse      = errors.New("must call Parse before using CloneOptions")
	ErrRepoNotFound = errors.New("git repository not found")
	ErrNoRemotes    = errors.New("no remotes in repository")
)

Errors

Functions

func Providers

func Providers() []string

Types

type Auth

type Auth struct {
	Username string
	Password string
}

type CloneOptions

type CloneOptions struct {
	// URL clone url
	Repo     string
	Auth     Auth
	FS       fs.FS
	Progress io.Writer
	// contains filtered or unexported fields
}

func AddFlags

func AddFlags(cmd *cobra.Command, bfs billy.Filesystem, prefix string) *CloneOptions

func (*CloneOptions) Clone

func (o *CloneOptions) Clone(ctx context.Context) (Repository, fs.FS, error)

func (*CloneOptions) Parse

func (o *CloneOptions) Parse()

func (*CloneOptions) Path

func (o *CloneOptions) Path() string

func (*CloneOptions) Revision

func (o *CloneOptions) Revision() string

func (*CloneOptions) URL

func (o *CloneOptions) URL() string

type CreateRepoOptions

type CreateRepoOptions struct {
	Owner   string
	Name    string
	Private bool
}

type GetRepoOptions

type GetRepoOptions struct {
	Owner string
	Name  string
}

type Provider

type Provider interface {
	// CreateRepository creates the repository in the remote provider and returns a
	// clone url
	CreateRepository(ctx context.Context, opts *CreateRepoOptions) (string, error)
}

Provider represents a git provider

func NewProvider

func NewProvider(opts *ProviderOptions) (Provider, error)

New creates a new git provider

type ProviderOptions

type ProviderOptions struct {
	Type string
	Auth *Auth
	Host string
}

ProviderOptions for a new git provider

type PushOptions

type PushOptions struct {
	AddGlobPattern string
	CommitMsg      string
}

type Repository

type Repository interface {
	// Persist runs add, commit and push to the repository default remote
	Persist(ctx context.Context, opts *PushOptions) error
}

Repository represents a git repository