github

package

v0.0.3 Latest Latest Go to latest Published: Aug 22, 2026 License: MIT Imports: 5 Imported by: 0

Documentation ¶

Overview ¶

Package github defines the client used to resolve a git_patch's github source (a pull request or commit) against the GitHub REST API. It is a thin wrapper around github.com/google/go-github so tests can inject a fake.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client interface {
	// ResolvePR resolves a pull request number in repository (in "owner/name"
	// form) to its head commit SHA and the pull request's unified diff.
	ResolvePR(ctx context.Context, repository string, pr int64, token string) (Resolution, error)

	// ResolveCommit resolves a commit sha in repository (in "owner/name"
	// form) to its diff.
	ResolveCommit(ctx context.Context, repository, sha, token string) (Resolution, error)
}

Client resolves github patch sources against the GitHub API. An empty token means an unauthenticated request.

func New ¶

func New(opts ...Option) Client

New creates a Client that talks to the GitHub REST API via go-github.

type Option ¶

type Option func(*client)

Option configures a client constructed via New.

func WithBaseURL ¶

func WithBaseURL(u string) Option

WithBaseURL overrides the API base URL. Intended for tests to point the client at a fake server.

type Resolution ¶

type Resolution struct {
	SHA  string
	Diff string
}

Resolution is the result of resolving a pull request or commit to a concrete commit SHA and unified diff.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL