gh

Documentation

Index

• func Ptr[T any](v T) *T
• type AddIssueLabelInput
• type Client
  • func NewClient(token string) (*Client, error)
  • func (c *Client) AddIssueLabels(ctx context.Context, input AddIssueLabelInput) error
  • func (c *Client) CreatePullRequest(ctx context.Context, input githubv4.CreatePullRequestInput) (*PullRequest, error)
  • func (c *Client) GetRepositoryBySlug(ctx context.Context, slug string) (*Repository, error)
  • func (c *Client) PullRequest(ctx context.Context, opts PullRequestOpts) (*PullRequest, error)
  • func (c *Client) RepoPullRequests(ctx context.Context, opts RepoPullRequestOpts) (RepoPullRequestsResponse, error)
• type PageInfo
• type PullRequest
  • func (p *PullRequest) BaseBranchName() string
  • func (p *PullRequest) HeadBranchName() string
• type PullRequestOpts
• type RepoPullRequestOpts
• type RepoPullRequestsResponse
• type Repository

Functions

func Ptr

func Ptr[T any](v T) *T

Ptr returns a pointer to the argument. It's a convenience function to make working with the API easier: since Go disallows pointers-to-literals, and optional input fields are expressed as pointers, this function can be used to easily set optional fields to non-nil primitives. For example, githubv4.CreatePullRequestInput{Draft: Ptr(true)}

Types

type AddIssueLabelInput

type AddIssueLabelInput struct {
	// The owner of the GitHub repository.
	Owner string
	// The name of the GitHub repository.
	Repo string
	// The number of the issue or pull request to add a label to.
	Number int64
	// The names of the labels to add to the issue. This will implicitly create
	// a label on the repository if the label doesn't already exist (this is the
	// main reason we use the REST API for this call).
	LabelNames []string
}

type Client

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

func NewClient

func NewClient(token string) (*Client, error)

func (*Client) AddIssueLabels

func (c *Client) AddIssueLabels(ctx context.Context, input AddIssueLabelInput) error

AddIssueLabels adds labels to an issue (or pull request, since in GitHub a pull request is a superset of an issue).

func (*Client) CreatePullRequest

func (c *Client) CreatePullRequest(ctx context.Context, input githubv4.CreatePullRequestInput) (*PullRequest, error)

func (*Client) GetRepositoryBySlug

func (c *Client) GetRepositoryBySlug(ctx context.Context, slug string) (*Repository, error)

func (*Client) PullRequest

func (c *Client) PullRequest(ctx context.Context, opts PullRequestOpts) (*PullRequest, error)

func (*Client) RepoPullRequests

func (c *Client) RepoPullRequests(ctx context.Context, opts RepoPullRequestOpts) (RepoPullRequestsResponse, error)

type PageInfo

type PageInfo struct {
	EndCursor       string
	HasNextPage     bool
	HasPreviousPage bool
	StartCursor     string
}

type PullRequest

type PullRequest struct {
	ID     string
	Number int64
	Author struct {
		Login string
	}
	HeadRefName string
	HeadRefOID  string
	BaseRefName string
	IsDraft     bool
	Mergeable   githubv4.MergeableState
	Merged      bool
	Permalink   string
	State       githubv4.PullRequestState
	Title       string
}

func (*PullRequest) BaseBranchName

func (p *PullRequest) BaseBranchName() string

func (*PullRequest) HeadBranchName

func (p *PullRequest) HeadBranchName() string

type PullRequestOpts

type PullRequestOpts struct {
	Owner  string
	Repo   string
	Number int64
}

type RepoPullRequestOpts

type RepoPullRequestOpts struct {
	Owner  string
	Repo   string
	First  int64
	After  string
	States []githubv4.PullRequestState
}

type RepoPullRequestsResponse

type RepoPullRequestsResponse struct {
	PageInfo
	TotalCount   int64
	PullRequests []PullRequest
}

type Repository

type Repository struct {
	ID    string
	Owner struct {
		Login string
	}
	Name string
}