git

Documentation

Index

• Variables
• type Author
• type Commit
• type CommitOptions
• type GPGSigningInfo
• type Git
• type GpgSigningOption
  • func (w GpgSigningOption) ApplyToCommit(in *CommitOptions)
• type Option
  • func WithGpgSigningOption(path, passphrase, keyID string) Option

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 CommitOptions

type CommitOptions struct {
	*GPGSigningInfo
}

CommitOptions contains options for making a commit.

type GPGSigningInfo

type GPGSigningInfo struct {
	KeyRingPath string
	Passphrase  string
	KeyID       string
}

GPGSigningInfo contains information for signing a commit.

type Git

type Git interface {
	Init(url, branch string) (bool, error)
	Clone(ctx context.Context, url, branch string, caBundle []byte) (bool, error)
	Write(path string, reader io.Reader) error
	Commit(message Commit, options ...Option) (string, error)
	Push(ctx context.Context, caBundle []byte) error
	Status() (bool, error)
	Head() (string, error)
	Path() string
}

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

type GpgSigningOption

type GpgSigningOption struct {
	*GPGSigningInfo
}

func (GpgSigningOption) ApplyToCommit

func (w GpgSigningOption) ApplyToCommit(in *CommitOptions)

type Option

type Option interface {
	// ApplyToCommit applies this configuration to a given commit option.
	ApplyToCommit(*CommitOptions)
}

Option is a some configuration that modifies options for a commit.

func WithGpgSigningOption

func WithGpgSigningOption(path, passphrase, keyID string) Option