gh

Documentation

Index

• Variables
• type Client
  • func NewClient(ctx context.Context) *Client
  • func (c *Client) Wait(ctx context.Context) error
• type Repo
  • func NewRepo(sshURL string, fullName string, size uint64) *Repo
  • func (r *Repo) CloneFS(ctx context.Context, sshKey *ssh.PublicKeys, pattern string, ...) error
  • func (r *Repo) CloneMem(ctx context.Context, sshKey *ssh.PublicKeys, pattern string, ...) error
  • func (r *Repo) Dir() string
  • func (r *Repo) Exists(fs billy.Filesystem) (bool, error)
  • func (r *Repo) FullName() string
  • func (r *Repo) GetDefaultBranch(ctx context.Context) string
  • func (r *Repo) GetGithubRepo(ctx context.Context) *github.Repository
  • func (r *Repo) SHA() string
  • func (r *Repo) SetSHA(sha string)
  • func (r *Repo) Size() uint64
  • func (r *Repo) SshURL() string

Variables

var (
	Delimiter     = "."
	DefaultBranch = "master"
)

Types

type Client

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

func NewClient

func NewClient(ctx context.Context) *Client

func (*Client) Wait

func (c *Client) Wait(ctx context.Context) error

type Repo

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

func NewRepo

func NewRepo(sshURL string, fullName string, size uint64) *Repo

func (*Repo) CloneFS

func (r *Repo) CloneFS(ctx context.Context, sshKey *ssh.PublicKeys, pattern string, outFs billy.Filesystem) error

func (*Repo) CloneMem

func (r *Repo) CloneMem(ctx context.Context, sshKey *ssh.PublicKeys, pattern string, outFs billy.Filesystem) error

func (*Repo) Dir

func (r *Repo) Dir() string

func (*Repo) Exists

func (r *Repo) Exists(fs billy.Filesystem) (bool, error)

func (*Repo) FullName

func (r *Repo) FullName() string

func (*Repo) GetDefaultBranch

func (r *Repo) GetDefaultBranch(ctx context.Context) string

func (*Repo) GetGithubRepo

func (r *Repo) GetGithubRepo(ctx context.Context) *github.Repository

func (*Repo) SHA

func (r *Repo) SHA() string

func (*Repo) SetSHA

func (r *Repo) SetSHA(sha string)

func (*Repo) Size

func (r *Repo) Size() uint64

func (*Repo) SshURL

func (r *Repo) SshURL() string