github

Documentation

Overview

Package github implements a client SDK for the Github API.

Index

• Constants
• type Client
  • func (c *Client) Commit(ctx context.Context, repository, sha string) (*Commit, error)
  • func (c *Client) OIDCToken(ctx context.Context, cfg OIDCVars) (token string, err error)
  • func (c *Client) PullReviews(ctx context.Context, repository string, nr int) (Reviews, error)
  • func (c *Client) PullsForCommit(ctx context.Context, repository, commit string) (pulls Pulls, err error)
• type Commit
• type GitMetadata
• type Label
• type OIDCVars
• type Pull
• type Pulls
• type RefInfo
• type Review
• type Reviews
• type User

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)"
)

const (
	// Domain is the default GitHub domain.
	Domain = "github.com"
	// APIDomain is the default GitHub API domain.
	APIDomain = "api." + Domain
	// APIBaseURL is the default base url for the GitHub API.
	APIBaseURL = "https://" + APIDomain
)

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) Commit

func (c *Client) Commit(ctx context.Context, repository, sha string) (*Commit, error)

Commit retrieves information about an specific commit in the GitHub API.

func (*Client) OIDCToken

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

OIDCToken requests a new OIDC token.

func (*Client) PullReviews

func (c *Client) PullReviews(ctx context.Context, repository string, nr int) (Reviews, error)

PullReviews returns the list of reviews of the given pull request number.

func (*Client) PullsForCommit

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

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

type Commit

type Commit struct {
	SHA    string `json:"sha"`
	Commit struct {
		Author    GitMetadata
		Committer GitMetadata
		Message   string
	} `json:"commit"`
	Author       User
	Committer    User
	Verification struct {
		Verified bool   `json:"verified"`
		Reason   string `json:"reason"`
	} `json:"verification"`
}

Commit holds information of a specific commit.

type GitMetadata

type GitMetadata struct {
	Name  string     `json:"name"`
	Email string     `json:"email"`
	Date  *time.Time `json:"date,omitempty"`
}

GitMetadata holds the commit metadata exported by Github.

type Label

type Label struct {
	Name        string `json:"name"`
	Color       string `json:"color"`
	Description string `json:"description,omitempty"`
}

Label of the issue or pull request.

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"`
	User      User       `json:"user"`
	CreatedAt *time.Time `json:"created_at,omitempty"`
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
	ClosedAt  *time.Time `json:"closed_at,omitempty"`
	MergedAt  *time.Time `json:"merged_at,omitempty"`

	MergeCommitSHA string  `json:"merge_commit_sha,omitempty"`
	Head           RefInfo `json:"head"`
	Base           RefInfo `json:"base"`
	Labels         []Label `json:"labels"`
}

Pull represents a pull request object.

type Pulls

type Pulls []Pull

Pulls represents a list of pull objects.

type RefInfo

type RefInfo struct {
	Label string `json:"label"`
	Ref   string `json:"ref"`
	SHA   string `json:"sha"`
	User  User   `json:"user"`
}

RefInfo contains metadata for the git ref (HEAD, branch, etc)

type Review

type Review struct {
	User              User      `json:"user"`
	Body              string    `json:"body,omitempty"`
	State             string    `json:"state,omitempty"`
	SubmittedAt       time.Time `json:"submitted_at,omitempty"`
	AuthorAssociation string    `json:"author_association,omitempty"`
	CommitID          string    `json:"commit_id,omitempty"`
}

Review represents the review information.

type Reviews

type Reviews []Review

Reviews is a list of review objects.

type User

type User struct {
	Login      string `json:"login"`
	AvatarURL  string `json:"avatar_url"`
	GravatarID string `json:"gravatar_id"`
	Type       string `json:"type"`
	SiteAdmin  bool   `json:"site_admin"`
}

User represents the Github user.