facts

type Check struct {
	Name       string `json:"name"`
	Status     string `json:"status"`     // expected, queued, in_progress, completed
	Conclusion string `json:"conclusion"` // success, failure, neutral, cancelled, skipped, timed_out, action_required, ""
	Required   bool   `json:"required"`
	// App is the slug of the GitHub App that reported a check run, and AppID its id. Both are
	// empty for a commit status, which has no App. On an expected check AppID is the App the
	// requirement is bound to, if it is bound to one, and App is empty.
	App   string `json:"app,omitempty"`
	AppID int64  `json:"app_id,omitempty"`
}

type Facts struct {
	Ticket *Ticket `json:"ticket,omitempty"`
	PR     *PR     `json:"pr,omitempty"`
	Lane   *Lane   `json:"lane,omitempty"`
}

type Lane struct {
	Paused        bool   `json:"paused"`
	PausedReason  string `json:"paused_reason,omitempty"`
	OpenProposals int    `json:"open_proposals"`
}

type PR struct {
	Number  int     `json:"number"`
	State   string  `json:"state"` // open, closed
	Merged  bool    `json:"merged"`
	Draft   bool    `json:"draft"`
	Fork    bool    `json:"fork"`
	HeadSHA string  `json:"head_sha"`
	HeadRef string  `json:"head_ref"`
	Checks  []Check `json:"checks"`
	// RequiredUnknown is true when neither branch protection nor the rulesets could be read, so
	// no check is marked required and every check gates (CIState).
	RequiredUnknown  bool `json:"required_unknown,omitempty"`
	ChangesRequested bool `json:"changes_requested"`
	Approved         bool `json:"approved"`
}

type Ticket struct {
	Key    string `json:"key"`              // the tracker's own key: owner/name#77, PLAT-881
	Number int    `json:"number,omitempty"` // a GitHub issue's number; 0 elsewhere
	// Repo is the repository the ticket itself names for its code, from a structured field its
	// tracker is configured to read; empty when it names none (ADR-002).
	Repo   string   `json:"repo,omitempty"`
	State  string   `json:"state"` // open, closed
	Labels []string `json:"labels"`
}