git

Documentation

Index

• type CreateRepoOpts
• type DeleteRepoOpts
• type GetRepoOpts
• type Provider
• type RemoteBranchDoesNotExistError
  • func (e *RemoteBranchDoesNotExistError) Error() string
• type Repository
• type RepositoryDoesNotExistError
  • func (e *RepositoryDoesNotExistError) Error() string
• type RepositoryIsEmptyError
  • func (e *RepositoryIsEmptyError) Error() string
• type RepositoryUpToDateError
  • func (e *RepositoryUpToDateError) Error() string
• type TokenAuth

Types

type CreateRepoOpts

type CreateRepoOpts struct {
	Name        string
	Owner       string
	Description string
	Personal    bool
	Privacy     bool
}

type DeleteRepoOpts

type DeleteRepoOpts struct {
	Owner      string
	Repository string
}

type GetRepoOpts

type GetRepoOpts struct {
	Owner      string
	Repository string
}

type Provider

type Provider interface {
	Add(filename string) error
	Remove(filename string) error
	Clone(ctx context.Context) error
	Commit(message string) error
	Push(ctx context.Context) error
	Pull(ctx context.Context, branch string) error
	Init() error
	Branch(name string) error
	GetRepo(ctx context.Context) (repo *Repository, err error)
	CreateRepo(ctx context.Context, opts CreateRepoOpts) (repo *Repository, err error)
	DeleteRepo(ctx context.Context, opts DeleteRepoOpts) error
	Validate(ctx context.Context) error
	PathExists(ctx context.Context, owner, repo, branch, path string) (bool, error)
}

Provider acts as an interface for specific Git hosting providers -- e.g. GitHub, BitBucket, GitLab, etc. It wraps a low-level git implementation (e.g. gogit) and abstracts auth and provider specific configurations while providing a common interface for local git actions.

type RemoteBranchDoesNotExistError

type RemoteBranchDoesNotExistError struct {
	Repository string
	Branch     string
}

func (*RemoteBranchDoesNotExistError) Error

func (e *RemoteBranchDoesNotExistError) Error() string

type Repository

type Repository struct {
	Name         string
	Owner        string
	Organization string
	CloneUrl     string
}

type RepositoryDoesNotExistError

type RepositoryDoesNotExistError struct {
	Err error
	// contains filtered or unexported fields
}

func (*RepositoryDoesNotExistError) Error

func (e *RepositoryDoesNotExistError) Error() string

type RepositoryIsEmptyError

type RepositoryIsEmptyError struct {
	Repository string
}

func (*RepositoryIsEmptyError) Error

func (e *RepositoryIsEmptyError) Error() string

type RepositoryUpToDateError

type RepositoryUpToDateError struct {
	Repository string
}

func (*RepositoryUpToDateError) Error

func (e *RepositoryUpToDateError) Error() string

type TokenAuth

type TokenAuth struct {
	Username string
	Token    string
}