github

Documentation

Overview

Package github implements a client SDK for the Github API.

Index

• Constants
• type Client
  • func (c *Client) OIDCToken(ctx context.Context, cfg OIDCVars) (token string, err error)
  • func (c *Client) PullsForCommit(ctx context.Context, repository, commit string) (pulls []Pull, err error)
• type OIDCVars
• type Pull
• type PullRequestHEAD
• type Pulls

Constants

const (
	// ErrNotFound indicates the resource does not exists.
	ErrNotFound errors.Kind = "resource not found (HTTP Status: 404)"
	// ErrUnprocessableEntity indicates the entity cannot be processed for any reason.
	ErrUnprocessableEntity errors.Kind = "entity cannot be processed (HTTP Status: 422)"
)

Types

type Client

type Client struct {
	// BaseURL is the base URL used to construct the final URL of endpoints.
	// If not set, then api.github.com is used.
	BaseURL string

	// HTTPClient sets the HTTP client used and then allows for advanced
	// connection reuse schemes. If not set, a new http.Client is used.
	HTTPClient *http.Client

	// Token is the Github token (usually provided by the GH_TOKEN environment
	// variable.
	Token string
}

Client is a Github HTTP client wrapper.

func (*Client) OIDCToken

func (c *Client) OIDCToken(ctx context.Context, cfg OIDCVars) (token string, err error)

OIDCToken requests a new OIDC token.

func (*Client) PullsForCommit

func (c *Client) PullsForCommit(ctx context.Context, repository, commit string) (pulls []Pull, err error)

PullsForCommit returns a list of pull request objects associated with the given commit SHA.

type OIDCVars

type OIDCVars struct {
	ReqURL   string
	ReqToken string
}

OIDCVars is the variables used for issuing new OIDC tokens.

type Pull

type Pull struct {
	URL       string    `json:"url"`
	HTMLURL   string    `json:"html_url"`
	Number    int       `json:"number"`
	Title     string    `json:"title"`
	Body      string    `json:"body"`
	State     string    `json:"state"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`

	HEAD PullRequestHEAD `json:"head"`
}

Pull represents a pull request object.

type PullRequestHEAD

type PullRequestHEAD struct {
	Ref string `json:"ref"`
	SHA string `json:"sha"`
}

PullRequestHEAD contains metadata for the PR HEAD.

type Pulls

type Pulls []Pull

Pulls represents a list of pull objects.