prwait

type ActionRun struct {
	Name       string `json:"name"`
	RunID      int64  `json:"runId"`
	Status     string `json:"status"`
	Conclusion string `json:"conclusion"`
	URL        string `json:"url"`
}

type Check struct {
	Name string `json:"name"`
	// ID is the check run's id, the job id of a GitHub Actions job; absent
	// for a status.
	ID int64 `json:"id,omitempty"`
	// Workflow is the GitHub Actions run the check run's job belongs to, when
	// the head's runs list it.
	Workflow string `json:"workflow,omitempty"`
	Source   string `json:"source"`
	// Status is queued, in_progress or completed for a check run; pending or
	// completed for a status.
	Status string `json:"status"`
	// Conclusion is the check run's conclusion or the status's state once it
	// is not pending; empty while unfinished.
	Conclusion string `json:"conclusion"`
	URL        string `json:"url"`
	// Required: branch protection or a ruleset of the base names this context.
	Required bool `json:"required"`
}

type CircleCI struct {
	PipelineID     string     `json:"pipelineId"`
	PipelineNumber int64      `json:"pipelineNumber"`
	Workflows      []Workflow `json:"workflows"`
}

type Config struct {
	// GitHub is required. From [githubclient.NewConditional] its polls are
	// conditional requests and Rate is the [githubclient.Conditional].
	GitHub *githubclient.Client
	// Rate is where the poll interval comes from; nil polls at the floor.
	Rate RateSource
	// CircleCI returns the client once the head is known to carry a CircleCI
	// configuration; it is the place the CircleCI token is required, so an
	// [agentcli.ExitCoder] it returns ends the wait with that code. nil
	// means CircleCI is never consulted.
	CircleCI func(ctx context.Context) (*circleciclient.Client, error)
	// Entries is read only for a template repository whose head carries
	// CircleCIConfigPath: GitHub alone judges it while its entry declares
	// gen.ci.templateContent. nil means no repository declares it.
	Entries EntryFinder
	// Clock defaults to the wall clock at scale 1.
	Clock agentcli.Clock
	// Progress may be nil.
	Progress *agentcli.Progress
	// Timeout defaults to DefaultTimeout.
	Timeout time.Duration
	// FailedLogLines, when positive, makes a red verdict read the log of
	// each failed job once and keep that many of its last lines in
	// Result.FailedJobs. A green or pending head reads no log.
	FailedLogLines int
}

type EntryFinder interface {
	FindEntry(ctx context.Context, owner, repo string) (*reposetup.Fields, bool, error)
}

type FailedJob struct {
	Name string `json:"name"`
	// Source is actions or circleci.
	Source string `json:"source"`
	URL    string `json:"url"`
	// LogTail is the last lines of the job's log; on CircleCI, of the output
	// of its failed steps.
	LogTail string `json:"logTail,omitempty"`
	// LogError says why the log could not be read; the verdict stands.
	LogError string `json:"logError,omitempty"`
}

type FailedLog struct {
	Enabled bool
	Lines   int
}

type RateSource interface {
	Rate() githubclient.RateLimit
}

type Result struct {
	Repository string `json:"repository"`
	Number     int    `json:"number"`
	HeadSHA    string `json:"headSha"`
	BaseRef    string `json:"baseRef"`
	// Checks are the head's check runs, every run of a name that counts, and
	// its statuses, the latest per context.
	Checks []Check `json:"checks"`
	// CircleCI is absent when the head carries no CircleCI configuration, the
	// repository is a template whose entry declares that configuration as
	// template content, or CircleCI has no project for it.
	CircleCI *CircleCI `json:"circleci,omitempty"`
	// Actions are the head's GitHub Actions runs, the latest per workflow.
	Actions []ActionRun `json:"actions"`
	// Unfinished names what the head was still waiting for when the wait
	// ended without a verdict.
	Unfinished []string `json:"unfinished,omitempty"`
	// FailedJobs are the failed jobs of a red head with the tails of their
	// logs, read with Config.FailedLogLines.
	FailedJobs []FailedJob `json:"failedJobs,omitempty"`
	// Warnings are for the envelope: a head that changed under the wait, a
	// template repository, a CircleCI project that does not exist.
	Warnings []string `json:"-"`
}

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

type Workflow struct {
	Name   string `json:"name"`
	Status string `json:"status"`
	URL    string `json:"url"`
}