pull

Documentation

Index

• type Context
  • func NewGitHubContext(ctx context.Context, mbrCtx pull.MembershipContext, ...) (Context, error)
• type GitHubContext
  • func (ghc *GitHubContext) DefaultBranch() string
  • func (ghc *GitHubContext) DownloadCode() (string, func(), error)
  • func (ghc *GitHubContext) LatestDetailedStatuses() (map[string]*github.RepoStatus, error)
• type Locator
  • func (loc Locator) IsComplete() bool

Types

type Context

type Context interface {
	pull.Context

	// DefaultBranch returns the default branch of the repo that the pull
	// request targets.
	DefaultBranch() string

	// DownloadCode downloads the code to a temporary directory and returns its
	// path and a cleanup function.
	DownloadCode() (path string, cleanup func(), err error)

	// LatestDetailedStatuses returns a map of status check names to the latest
	// detailed result
	LatestDetailedStatuses() (map[string]*github.RepoStatus, error)
}

func NewGitHubContext

func NewGitHubContext(ctx context.Context, mbrCtx pull.MembershipContext, globalCache pull.GlobalCache, client *github.Client, v4client *githubv4.Client, httpClient *http.Client, loc Locator) (Context, error)

type GitHubContext

type GitHubContext struct {
	pull.Context
	// contains filtered or unexported fields
}

func (*GitHubContext) DefaultBranch

func (ghc *GitHubContext) DefaultBranch() string

func (*GitHubContext) DownloadCode

func (ghc *GitHubContext) DownloadCode() (string, func(), error)

func (*GitHubContext) LatestDetailedStatuses

func (ghc *GitHubContext) LatestDetailedStatuses() (map[string]*github.RepoStatus, error)

type Locator

type Locator pull.Locator

Locator identifies a pull request and optionally contains a full or partial pull request object.

func (Locator) IsComplete

func (loc Locator) IsComplete() bool

IsComplete returns true if the locator contains a pull request object with all required fields.