@usine/core/attempt/salvage
Classes
Section titled “Classes”SalvagePushed
Section titled “SalvagePushed”The Attempt’s unfinished work was committed and pushed to ref; commit is the pushed head.
Extends
Section titled “Extends”Schema.Class
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SalvagePushed(…
args):SalvagePushed
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
…args |
[props: object, options?: MakeOptions] |
Returns
Section titled “Returns”Properties
Section titled “Properties”commit
Section titled “commit”
readonlycommit:string&Brand<"CommitSha">
readonlyref:string&Brand<"SalvageRef">
SalvageRetained
Section titled “SalvageRetained”Salvage failed; path stays on the Worker for reconciliation. commit is the last known commit, or absent when inspection failed.
Extends
Section titled “Extends”Schema.Class
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SalvageRetained(…
args):SalvageRetained
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
…args |
[props: object, options?: MakeOptions] |
Returns
Section titled “Returns”Properties
Section titled “Properties”commit
Section titled “commit”
readonlycommit:Option<string&Brand<"CommitSha">>
message
Section titled “message”
readonlymessage:string
readonlypath:string
Interfaces
Section titled “Interfaces”AttemptRecovery
Section titled “AttemptRecovery”Identifies a persisted Attempt whose Worker may still hold a checkout.
Properties
Section titled “Properties”attemptId
Section titled “attemptId”
readonlyattemptId:string&Brand<"AttemptId">
readonlyopen:boolean
The Attempt has no outcome yet: an orchestrator restart may reattach it if its parent task is still live.
readonlyref:string&Brand<"SalvageRef">
repository
Section titled “repository”
readonlyrepository:string&Brand<"RepositoryName">
succeeded
Section titled “succeeded”
readonlysucceeded:boolean
The Attempt delivered its result, so a leftover checkout is removed rather than salvaged.
worker
Section titled “worker”
readonlyworker:string&Brand<"WorkerName">
Type Aliases
Section titled “Type Aliases”AttemptSalvage
Section titled “AttemptSalvage”AttemptSalvage = typeof
AttemptSalvage.Type
What the executor preserved of an Attempt’s workspace when the Attempt ended without a Succeeded outcome.
SalvageRef
Section titled “SalvageRef”SalvageRef = typeof
SalvageRef.Type
The remote branch name that holds one Attempt’s unfinished work, usine/salvage/<run>/<attempt>.
Variables
Section titled “Variables”AttemptSalvage
Section titled “AttemptSalvage”
constAttemptSalvage:Schema.Union<readonly [typeofSalvagePushed, typeofSalvageRetained]>
What the executor preserved of an Attempt’s workspace when the Attempt ended without a Succeeded outcome.
SalvageRef
Section titled “SalvageRef”
constSalvageRef:Schema.brand<Schema.NonEmptyString,"SalvageRef">
The remote branch name that holds one Attempt’s unfinished work, usine/salvage/<run>/<attempt>.
salvageRefFor
Section titled “salvageRefFor”
constsalvageRefFor: (runId,number) =>SalvageRef
The salvage branch an Attempt pushes to when it ends without success.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
runId |
RunId |
number |
AttemptNumber |