gh

Documentation

Index

• Variables
• type Client
  • func NewClient(token string) *Client
  • func (c *Client) DownloadFileFromRelease(ctx context.Context, owner, repo string, httpClient *http.Client, ...) (*ReleaseFile, error)
• type ReleaseFile
• type ReleaseInfo
• type RepoClient

Variables

var (
	ErrRateLimit             = errors.New("rate limit hit")
	ErrAssetNotFound         = errors.New("asset not found")
	ErrUnableToDownloadAsset = errors.New("unable to download asset")
	ErrUnableToReadAsset     = errors.New("unable to download asset")
	ErrFatalError            = errors.New("fatal error using github")
)

Types

type Client

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

func NewClient

func NewClient(token string) *Client

NewClient creates a new Github Client. If the token is not empty, it will use it as the auth token to make calls.

func (*Client) DownloadFileFromRelease

func (c *Client) DownloadFileFromRelease(
	ctx context.Context,
	owner, repo string,
	httpClient *http.Client,
	filePattern string) (*ReleaseFile, error)

type ReleaseFile

type ReleaseFile struct {
	Contents io.ReadCloser
	Info     ReleaseInfo
}

ReleaseFile represents a file in a given Github release.

type ReleaseInfo

type ReleaseInfo struct {
	// If the tag is valid, the will be non null.
	Tag *string
}

type RepoClient

type RepoClient interface {
	GetLatestRelease(ctx context.Context, owner, repo string) (*github.RepositoryRelease, *github.Response, error)
}