pullrequest

type API interface {
	// FindOpen returns the first open pull request from head into base, and false when there is none.
	FindOpen(ctx context.Context, head, base string) (Ref, bool, error)
	// Create opens a pull request from head into base.
	Create(ctx context.Context, head, base, title, body string) (Ref, error)
	// Edit sets the title and body of an open pull request.
	Edit(ctx context.Context, number int, title, body string) error
	// Status reads a pull request's state, head and standing reviews.
	Status(ctx context.Context, number int) (Status, error)
	// Close comments on a pull request, then closes it without merging.
	Close(ctx context.Context, number int, comment string) error
	// Reopen reopens a pull request closed without merging, so it can be merged.
	Reopen(ctx context.Context, number int) error
	// SetDraft turns an open pull request into a draft, or a draft back into one ready for review.
	SetDraft(ctx context.Context, number int, draft bool) error
	// Comment posts one comment on a pull request.
	Comment(ctx context.Context, number int, body string) error
	// Merge merges a pull request whose head is expectedHead, squashing when squash is set.
	// A merge GitHub refuses returns a *MergeRefusal.
	Merge(ctx context.Context, number int, expectedHead string, squash bool, title, message string) error
	// RequiresPullRequest reports whether a repository rule active on branch requires a pull request.
	// Such a rule makes GitHub refuse a direct push to branch.
	RequiresPullRequest(ctx context.Context, branch string) (bool, error)
	// RequiredChecks returns the status checks the repository's rules for base require, each with its conclusion at head.
	RequiredChecks(ctx context.Context, base, head string) ([]Check, error)
}

type Check struct {
	// Name is the check's name, the context a rule requires.
	Name string
	// Conclusion is the check's conclusion at the head:
	// empty while it has not finished, and CheckMissing when no check run or commit status of it exists there.
	Conclusion string
}

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

type MergeRefusal struct {
	// Kind classifies the refusal from GitHub's message.
	Kind RefusalKind
	// Message is GitHub's own message.
	Message string
}

type MergeState struct {
	// State is where the pull request stands.
	State State
	// Draft reports whether the pull request is a draft.
	Draft bool
	// Head is the pull request's current head commit.
	Head string
	// MergeableState is GitHub's mergeable_state of the pull request.
	MergeableState string
	// Approved reports whether a standing review approves Head.
	Approved bool
	// Checks are the required checks of the base branch, each with its conclusion at Head.
	Checks []Check
	// MergeableNow reports whether GitHub would merge the pull request now.
	// It must be open, not a draft, at the beam's head, and in a mergeable state of clean, has_hooks or unstable.
	MergeableNow bool
	// Causes name what stops the merge, one per cause; empty exactly when MergeableNow.
	Causes []string
}

type Record struct {
	// Number is the pull request's number and the one field always written.
	Number int `json:"number"`
	// URL is the pull request's page on GitHub.
	URL string `json:"url,omitempty"`
	// Base is the branch the pull request merges into.
	Base string `json:"base,omitempty"`
	// Head is the task branch the pull request merges from.
	Head string `json:"head,omitempty"`
	// GatedHead is the head the PR-Review row last gated and pushed.
	GatedHead string `json:"gated_head,omitempty"`
	// MailedHead is the head whose gate failure was mailed, so one failure is mailed once.
	MailedHead string `json:"mailed_head,omitempty"`
	// StrandGUID, StrandName, SessionID and Engine name the interactive PR-Review session, so a later pass resumes it.
	StrandGUID string `json:"strand_guid,omitempty"`
	StrandName string `json:"strand_name,omitempty"`
	SessionID  string `json:"session_id,omitempty"`
	Engine     string `json:"engine,omitempty"`
	// Continue is the operator's continue flag, set by `lym loom pr-continue`.
	Continue bool `json:"continue,omitempty"`
	// ReviewEnded records that the review ended.
	// The PR-Review row sets it when it closes the pull request on the continue flag.
	// Finalize sets it on the record it opens for a parent that takes its pull request with no review.
	// In that case the pull request is left for Finalize to merge.
	// The JSON key stays `closed_for_continue`, so a record written by an older build reads the same.
	ReviewEnded bool `json:"closed_for_continue,omitempty"`
	// ParentReviewAsked records that the PR-Review row asked the parent orch to review this pull request.
	ParentReviewAsked bool `json:"parent_review_asked,omitempty"`
}

type Ref struct {
	Number int
	URL    string
}

type RefusalKind string

type State string

type Status struct {
	State State
	// HeadSHA is the pull request's current head commit.
	HeadSHA string
	// Approved reports whether a reviewer's standing review approves HeadSHA.
	Approved bool
	// ChangesRequested reports whether any reviewer's standing review requests changes.
	ChangesRequested bool
	// Draft reports whether the pull request is a draft, which GitHub refuses to merge.
	Draft bool
	// MergeableState is GitHub's mergeable_state of the pull request:
	// clean, dirty, blocked, behind, unstable, has_hooks, unknown or draft.
	MergeableState string
}