git

Documentation

Index

• Variables
• type Author
• type Commit
• type Git
• type GoGit
  • func New(auth transport.AuthMethod) *GoGit
  • func (g *GoGit) Clone(ctx context.Context, path, url, branch string) (bool, error)
  • func (g *GoGit) Commit(message Commit, filters ...func(string) bool) (string, error)
  • func (g *GoGit) Head() (string, error)
  • func (g *GoGit) Init(path, url, branch string) (bool, error)
  • func (g *GoGit) Open(path string) (*gogit.Repository, error)
  • func (g *GoGit) Push(ctx context.Context) error
  • func (g *GoGit) Status() (bool, error)
  • func (g *GoGit) Write(path string, content []byte) error

Variables

var (
	ErrNoGitRepository = errors.New("no git repository")
	ErrNoStagedFiles   = errors.New("no staged files")
)

Types

type Author

type Author struct {
	Name  string
	Email string
}

type Commit

type Commit struct {
	Author
	Hash    string
	Message string
}

type Git

type Git interface {
	Open(path string) (*gogit.Repository, error)
	Init(path, url, branch string) (bool, error)
	Clone(ctx context.Context, path, url, branch string) (bool, error)
	Write(path string, content []byte) error
	Commit(message Commit, filters ...func(string) bool) (string, error)
	Push(ctx context.Context) error
	Status() (bool, error)
	Head() (string, error)
}

Git is an interface for basic Git operations on a single branch of a remote repository.

type GoGit

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

func New

func New(auth transport.AuthMethod) *GoGit

func (*GoGit) Clone

func (g *GoGit) Clone(ctx context.Context, path, url, branch string) (bool, error)

func (*GoGit) Commit

func (g *GoGit) Commit(message Commit, filters ...func(string) bool) (string, error)

func (*GoGit) Head

func (g *GoGit) Head() (string, error)

func (*GoGit) Init

func (g *GoGit) Init(path, url, branch string) (bool, error)

func (*GoGit) Open

func (g *GoGit) Open(path string) (*gogit.Repository, error)

func (*GoGit) Push

func (g *GoGit) Push(ctx context.Context) error

func (*GoGit) Status

func (g *GoGit) Status() (bool, error)

func (*GoGit) Write

func (g *GoGit) Write(path string, content []byte) error