vcs

Documentation

Index

• type File
• type Repository
  • func Open(path string) (Repository, error)

Types

type File

type File interface {
	Write(b []byte) error
	Read() ([]byte, error)
}

type Repository

type Repository interface {
	// CommitFiles commits with 'message' for files specified by 'paths'. 'prepFiles' is given exclusive access to files during execution
	CommitFiles(prepFiles func() error, message string, paths ...string) error
	// File returns a version-controlled file, capable of writing and committing in one operation
	File(path string) File
}

Repository is a Git repository with thread-safe file operations

func Open

func Open(path string) (Repository, error)

Open ensures a Git repo exists at 'path' and returns its Repository