client

Documentation

Index

• type Client
  • func New(ghc *github.Client) Client
  • func NewRecorder(c Client, recordDir string) Client
  • func NewReplayer(replayDir string) Client

Types

type Client

type Client interface {
	GetCommit(ctx context.Context, owner string, repo string, sha string) (*github.Commit, *github.Response, error)
	ListCommits(ctx context.Context, owner, repo string, opt *github.CommitsListOptions) ([]*github.RepositoryCommit, *github.Response, error)
	ListPullRequestsWithCommit(ctx context.Context, owner, repo, sha string, opt *github.PullRequestListOptions) ([]*github.PullRequest, *github.Response, error)
	GetPullRequest(ctx context.Context, owner string, repo string, number int) (*github.PullRequest, *github.Response, error)

	// TODO: get rid of that method, currently only used in some test case
	GetRepoCommit(ctx context.Context, owner, repo, sha string) (*github.RepositoryCommit, *github.Response, error)
}

Client is used to talk to GitHub and query the repo/commit information needed to assemble the release notes

func New

func New(ghc *github.Client) Client

func NewRecorder

func NewRecorder(c Client, recordDir string) Client

func NewReplayer

func NewReplayer(replayDir string) Client