github

Documentation

Index

• Constants
• func GHLoginStep(opts GHLoginOpts) *bootstrap.Step
• func PackageSource(ghc *Client, owner, repo, tag string, ...) apt.PackageSource[*ghr]
• type Client
  • func NewClient(opts ...ClientOpt) *Client
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
  • func (c *Client) DoAndParse(req *http.Request, respData any) error
  • func (c *Client) Download(ctx context.Context, url string) (*http.Response, error)
  • func (c *Client) DownloadReq(ctx context.Context, url string) (*http.Request, error)
  • func (c *Client) Get(ctx context.Context, path string, respData any) error
  • func (c *Client) GetRelease(ctx context.Context, owner, repo, tag string) (*Release, error)
• type ClientOpt
  • func WithToken(token string) ClientOpt
• type GHLoginOpts
• type Release
• type ReleaseAsset

Constants

const StepNameAuthLogin = "gh auth login"

Functions

func GHLoginStep

func GHLoginStep(opts GHLoginOpts) *bootstrap.Step

func PackageSource

func PackageSource(
	ghc *Client,
	owner, repo, tag string,
	assetMatch func(*Release, *ReleaseAsset) bool,
) apt.PackageSource[*ghr]

Types

type Client

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

Client provides a rudimentary client for acccessing GitHub resources over its REST api, without pulling in large dependencies.

func NewClient

func NewClient(opts ...ClientOpt) *Client

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

func (*Client) DoAndParse

func (c *Client) DoAndParse(req *http.Request, respData any) error

func (*Client) Download

func (c *Client) Download(ctx context.Context, url string) (*http.Response, error)

func (*Client) DownloadReq

func (c *Client) DownloadReq(ctx context.Context, url string) (*http.Request, error)

func (*Client) Get

func (c *Client) Get(ctx context.Context, path string, respData any) error

func (*Client) GetRelease

func (c *Client) GetRelease(ctx context.Context, owner, repo, tag string) (*Release, error)

type ClientOpt

type ClientOpt func(*Client)

func WithToken

func WithToken(token string) ClientOpt

type GHLoginOpts

type GHLoginOpts struct {
	// value for `--git-protocol` arg, "https" or "ssh", or empty string to omit
	// the arg.
	GitProtocol string
	// value for `--hostname` arg, or empty string to omit it
	Hostname string
	// values to pass to `--scopes`, or nil/empty to omit it
	Scopes []string
}

type Release

type Release struct {
	TagName string         `json:"tag_name"`
	Assets  []ReleaseAsset `json:"assets"`
}

type ReleaseAsset

type ReleaseAsset struct {
	URL string `json:"url"`

	Name        string `json:"name"`
	Label       string `json:"label"`
	ContentType string `json:"content_type"`
	Size        int    `json:"size"`
}