gogit

Documentation

Index

• Constants
• func WithDiskStorage(g *Client) error
• func WithMemoryStorage(g *Client) error
• type Client
  • func NewClient(path string, authOpts *git.AuthOptions, clientOpts ...ClientOption) (*Client, error)
  • func (g *Client) Clone(ctx context.Context, url string, checkoutOpts git.CheckoutOptions) (*git.Commit, error)
  • func (g *Client) Commit(info git.Commit, signer *openpgp.Entity) (string, error)
  • func (g *Client) Head() (string, error)
  • func (g *Client) Init(ctx context.Context, url, branch string) error
  • func (g *Client) IsClean() (bool, error)
  • func (g *Client) Path() string
  • func (g *Client) Push(ctx context.Context) error
  • func (g *Client) SwitchBranch(ctx context.Context, branchName string) error
  • func (g *Client) WriteFile(path string, reader io.Reader) error
• type ClientOption
  • func WithStorer(s storage.Storer) ClientOption
  • func WithWorkTreeFS(wt billy.Filesystem) ClientOption
• type CustomPublicKeys
  • func (a *CustomPublicKeys) ClientConfig() (*gossh.ClientConfig, error)
  • func (a *CustomPublicKeys) Name() string
  • func (a *CustomPublicKeys) String() string

Constants

const ClientName = "go-git"

ClientName is the string representation of Client.

Functions

func WithDiskStorage

func WithDiskStorage(g *Client) error

func WithMemoryStorage

func WithMemoryStorage(g *Client) error

Types

type Client

type Client struct {
	*git.DiscardRepositoryCloser
	// contains filtered or unexported fields
}

Client implements git.RepositoryClient.

func NewClient

func NewClient(path string, authOpts *git.AuthOptions, clientOpts ...ClientOption) (*Client, error)

NewClient returns a new GoGitClient.

func (*Client) Clone

func (g *Client) Clone(ctx context.Context, url string, checkoutOpts git.CheckoutOptions) (*git.Commit, error)

func (*Client) Commit

func (g *Client) Commit(info git.Commit, signer *openpgp.Entity) (string, error)

func (*Client) Head

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

func (*Client) Init

func (g *Client) Init(ctx context.Context, url, branch string) error

func (*Client) IsClean

func (g *Client) IsClean() (bool, error)

func (*Client) Path

func (g *Client) Path() string

func (*Client) Push

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

func (*Client) SwitchBranch

func (g *Client) SwitchBranch(ctx context.Context, branchName string) error

func (*Client) WriteFile

func (g *Client) WriteFile(path string, reader io.Reader) error

type ClientOption

type ClientOption func(*Client) error

func WithStorer

func WithStorer(s storage.Storer) ClientOption

func WithWorkTreeFS

func WithWorkTreeFS(wt billy.Filesystem) ClientOption

type CustomPublicKeys

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

CustomPublicKeys is a wrapper around ssh.PublicKeys to help us customize the ssh config. It implements ssh.AuthMethod.

func (*CustomPublicKeys) ClientConfig

func (a *CustomPublicKeys) ClientConfig() (*gossh.ClientConfig, error)

func (*CustomPublicKeys) Name

func (a *CustomPublicKeys) Name() string

func (*CustomPublicKeys) String

func (a *CustomPublicKeys) String() string