git

Documentation

Index

• Variables
• type Auth
• type CloneOptions
• type CreateRepoOptions
• type GetRepoOptions
• type Options
• type Provider
  • func NewProvider(opts *Options) (Provider, error)
• type PushOptions
• type Repository
  • func Clone(ctx context.Context, opts *CloneOptions) (Repository, error)
  • func Init(ctx context.Context, path string) (Repository, error)

Variables

var (
	ErrNilOpts      = errors.New("options cannot be nil")
	ErrRepoNotFound = errors.New("git repository not found")
)

Errors

var (
	ErrProviderNotSupported = errors.New("git provider not supported")
)

Errors

Types

type Auth

type Auth struct {
	Username string
	Password string
}

Auth for git provider

type CloneOptions

type CloneOptions struct {
	// URL clone url
	URL string
	// Path where to clone to
	Path string
	Auth *Auth
}

type CreateRepoOptions

type CreateRepoOptions struct {
	Owner   string
	Name    string
	Private bool
}

type GetRepoOptions

type GetRepoOptions struct {
	Owner string
	Name  string
}

type Options

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

Options for a new git provider

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)

	GetRepository(ctx context.Context, opts *GetRepoOptions) (string, error)
}

Provider represents a git provider

func NewProvider

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

New creates a new git provider

type PushOptions

type PushOptions struct {
	RemoteName string
	Auth       *Auth
}

type Repository

type Repository interface {
	Add(ctx context.Context, pattern string) error

	AddRemote(ctx context.Context, name, url string) error

	// Commits all files and returns the commit sha
	Commit(ctx context.Context, msg string) (string, error)

	Push(context.Context, *PushOptions) error

	IsNewRepo() (bool, error)

	Root() (string, error)
}

Repository represents a git repository

func Clone

func Clone(ctx context.Context, opts *CloneOptions) (Repository, error)

func Init

func Init(ctx context.Context, path string) (Repository, error)