Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrInvalidPath = stderrors.New("invalid path")
ErrInvalidPath is returned when the requested path fails validation.
View Source
var ErrNotFound = stderrors.New("file not found")
ErrNotFound is returned when a requested file does not exist in the repository.
Functions ¶
This section is empty.
Types ¶
type Git ¶
type Git interface {
WriteFile(ctx context.Context, path string, content []byte) error
DeleteFile(ctx context.Context, path string) error
ReadFile(ctx context.Context, path string) ([]byte, error)
ListFiles(ctx context.Context, pattern string) ([]string, error)
Pull(ctx context.Context) error
Status(ctx context.Context) (Status, error)
Clone(ctx context.Context, remoteURL RemoteURL) error
ConfigureUser(ctx context.Context, name string, email string) error
Init(ctx context.Context) error
}
Git abstracts all git shell operations on a local repository.
func New ¶
func New( repoPath string, m metrics.Metrics, currentDateTimeGetter libtime.CurrentDateTimeGetter, sshKeyPath SSHKeyPath, ) Git
New returns a Git implementation backed by the system git binary for the given repository path.
type RemoteURL ¶ added in v0.9.0
type RemoteURL string
RemoteURL is the URL of a remote git repository.
type SSHKeyPath ¶ added in v0.8.0
type SSHKeyPath string
SSHKeyPath is the path to an SSH private key used for git operations.
Click to show internal directories.
Click to hide internal directories.