Documentation
¶
Overview ¶
Package github implements the forge operations over the gh CLI. It depends only on internal/domain and is wired in by forge.Select.
Index ¶
- type Client
- func (c *Client) GetIssue(ctx context.Context, r domain.Repo, id string) (domain.Issue, error)
- func (c *Client) GetPR(ctx context.Context, r domain.Repo, number int) (domain.PullRequest, error)
- func (c *Client) ListChecks(ctx context.Context, r domain.Repo, number int) ([]domain.Check, error)
- func (c *Client) ListComments(ctx context.Context, r domain.Repo, number int) ([]domain.Comment, error)
- func (c *Client) Name() string
- func (c *Client) OpenPR(ctx context.Context, r domain.Repo, o domain.OpenPROpts) (domain.PullRequest, error)
- func (c *Client) PRForBranch(ctx context.Context, r domain.Repo, branch string) (*domain.PullRequest, error)
- func (c *Client) PostComment(ctx context.Context, r domain.Repo, number int, body string) (domain.Comment, error)
- func (c *Client) WatchChecks(ctx context.Context, r domain.Repo, number int, ...) (domain.CheckSummary, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client talks to GitHub through the gh CLI.
func New ¶
func New(cfg config.GitHubConfig) (*Client, error)
New verifies gh is available and returns a Client.
func (*Client) ListChecks ¶
func (*Client) ListComments ¶
func (*Client) OpenPR ¶
func (c *Client) OpenPR(ctx context.Context, r domain.Repo, o domain.OpenPROpts) (domain.PullRequest, error)
func (*Client) PRForBranch ¶
func (*Client) PostComment ¶
func (*Client) WatchChecks ¶
Source Files
Click to show internal directories.
Click to hide internal directories.