git

Documentation

Index

• type Client
  • func NewClient(dirName, url string, opts ...Option) (*Client, error)
  • func (c *Client) Clean() error
  • func (c *Client) Clone() error
  • func (c *Client) GetBranchName() string
  • func (c *Client) GetDirectoryPath() string
  • func (c *Client) GetGitParams() (url, ref string, cloneDepth int)
  • func (c *Client) GetHeadRevision() (string, error)
  • func (c *Client) GetName() string
  • func (c *Client) GetPath() string
  • func (c *Client) Pull() error
• type Option
  • func WithAuth(username, passwordOrToken string) Option
  • func WithCloneDepth(depth int) Option
  • func WithCloneTimeout(timeout time.Duration) Option
  • func WithPullTimeout(timeout time.Duration) Option
  • func WithPushTimeout(timeout time.Duration) Option
  • func WithReferenceName(refName string) Option

Types

type Client

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

Client manages client side of git

func NewClient

func NewClient(dirName, url string, opts ...Option) (*Client, error)

NewClient creates a new git client

func (*Client) Clean

func (c *Client) Clean() error

Clean deletes the git directory

func (*Client) Clone

func (c *Client) Clone() error

Clone clones a repository into defined path

func (*Client) GetBranchName

func (c *Client) GetBranchName() string

func (*Client) GetDirectoryPath

func (c *Client) GetDirectoryPath() string

GetDirectoryPath returns a directory path which project was cloned

func (*Client) GetGitParams

func (c *Client) GetGitParams() (url, ref string, cloneDepth int)

GetGitParams returns params of git client

func (*Client) GetHeadRevision

func (c *Client) GetHeadRevision() (string, error)

GetHeadRevision returns a revision of HEAD commit

func (*Client) GetName

func (c *Client) GetName() string

func (*Client) GetPath

func (c *Client) GetPath() string

func (*Client) Pull

func (c *Client) Pull() error

Pull pulls changes from git repository

type Option

type Option func(client *Client)

func WithAuth

func WithAuth(username, passwordOrToken string) Option

func WithCloneDepth

func WithCloneDepth(depth int) Option

func WithCloneTimeout

func WithCloneTimeout(timeout time.Duration) Option

func WithPullTimeout

func WithPullTimeout(timeout time.Duration) Option

func WithPushTimeout

func WithPushTimeout(timeout time.Duration) Option

func WithReferenceName

func WithReferenceName(refName string) Option