@usine/core/step/harvest

Classes

HarvestError

git or GitHub answered a harvesting command with output that is not a valid result.

Extends

• Schema.Class

Constructors

Constructor

new HarvestError(…args): HarvestError

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

HarvestError

Properties

cause

readonly cause: unknown

message

readonly message: string

stage

readonly stage: "git" | "github"

Type Aliases

HarvestCommand

HarvestCommand<E> = (command, args) => Effect.Effect<ReadonlyArray<string>, E>

Runs one read-only git or gh command in the Attempt’s checkout and returns its stdout lines. A non-zero exit is the runner’s own failure.

Type Parameters

Type Parameter
E

Parameters

Parameter	Type
command	"git" | "gh"
args	ReadonlyArray<string>

Returns

Effect.Effect<ReadonlyArray<string>, E>

---

HarvestSpec

HarvestSpec = Pick<RunSpec, "attemptId" | "repository" | "revision" | "baseCommit">

The part of an Attempt’s RunSpec that harvesting reads: where its checkout started and what it was given.

Variables

harvestFacts

const harvestFacts: <E>(spec, run) => Effect.Effect<readonly (Comment | Commit | PullRequest)[], E | HarvestError, never>

The facts an Attempt’s checkout holds once its agent has finished: new commits, then the pull requests at its final commit. Pull request discovery is read-only enrichment, so a GitHub failure or a ten-second stall keeps the commits and records no pull request rather than failing completed work.

Type Parameters

Type Parameter
E extends object

Parameters

Parameter	Type
spec	HarvestSpec
run	HarvestCommand<E>

Returns

Effect.Effect<readonly (Comment | Commit | PullRequest)[], E | HarvestError, never>