Skip to main content
Pulumi logo Pulumi logo
  1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. DeliveryRun

DeliveryRun

    The page of one Delivery run.

    Properties

    • summary DeliveryRunSummary required
      The facts of the run.
    • ↳ number integer required
      The number of the run.
    • ↳ kind enum required
      The kind of the run.
      Values:
      normal — Normal
      A run that a trigger started.
      rollback — Rollback
      A run that an operator started to return a stage to an earlier release.
      redeploy — Redeploy
      A run that an operator started to deploy a stage again.
      force_promote — ForcePromote
      A run that an operator started to promote a release past its gates.
    • ↳ status DeliveryStatus required
      The structured status of the run.
    • ↳ triggerKind enum required
      What started the run.
      Values:
      registration — Registration
      A registration of the program.
      push — Push
      A push of a source.
      dispatch — Dispatch
      A dispatch by a user.
      operator — Operator
      An operator action on a stage.
      stage_converged — StageConverged
      A stage of another pipeline that converged.
      local — Local
      A local pulumi up of the pipeline stack.
    • ↳ actorKind enum required
      Who started the run: user, webhook, trigger or system.
      Values: user, webhook, system, trigger
    • ↳ actor string optional
      The login of the user who started the run, if a user did.
    • ↳ targetStage string optional
      The stage that an operator run deploys.
    • ↳ releaseNumber integer optional
      The number of the release of the run.
    • ↳ programCommit DeliveryCommit optional
      The commit of the program that the run executes.
    • ↳ programRef string optional
      The ref (branch, tag or commit SHA) that a person started the run at. Absent for a run at the head of the program branch.
    • ↳ originRunNumber integer optional
      The number of the run that an operator run repeats.
    • ↳ stages array[DeliveryRunStageSummary] optional
      One entry for each stage of the run, in the order of the stages.
    • ↳ createdAt string required
      When the run was created.
    • ↳ finishedAt string optional
      When the run ended.
    • ↳ local boolean optional
      Whether the run is a local run, started with pulumi up. Set only when it is.
    • failureReason string optional
      Why the run failed.
    • canceledBy string optional
      The login of the user who canceled the run.
    • canceledAt string optional
      When the run was canceled.
    • runStack DeliveryStackRef optional
      The stack that the program of the run runs on.
    • ↳ project string required
      The project name of the stack.
    • ↳ stack string required
      The name of the stack.
    • ↳ exists boolean required
      Whether the stack still exists. A run stack is deleted with its pipeline.
    • localUpdate DeliveryLocalUpdate optional
      The update of the pipeline stack that drove the run. Set only for a local run, which has no run stack.
    • ↳ project string required
      The project name of the pipeline stack.
    • ↳ stack string required
      The name of the pipeline stack.
    • ↳ version integer required
      The version of the update on the pipeline stack.
    • passCount integer required
      The number of passes of the run.
    • currentPass DeliveryPass optional
      The latest pass of the run.
    • ↳ number integer required
      The number of the pass in the run.
    • ↳ status enum required
      The status of the pass.
      Values: queued, running, finished
    • ↳ outcome enum optional
      The outcome of a finished pass.
      Values: awaiting, completed, failed, canceled
    • ↳ updateId string optional
      The ID of the update of the run stack that the pass made.
    • ↳ failureReason string optional
      Why the pass failed. Free-form text.
    • ↳ createdAt string required
      When the pass was queued.
    • ↳ startedAt string optional
      When the pass started.
    • ↳ finishedAt string optional
      When the pass ended.
    • stages array[DeliveryRunStage] optional
      The stages of the run.
    • ↳ name string required
      The name of the stage.
    • ↳ status DeliveryStatus required
      The structured status of the stage in the run.
    • ↳ from array[string] optional
      The names of the stages that must converge first.
    • ↳ when array[string] optional
      The kinds and names of the conditions that the run declared for the stage, as kind:name.
    • ↳ admittedAt string optional
      When the stage got its lock.
    • ↳ convergedAt string optional
      When the stage converged.
    • ↳ gate DeliveryGate optional
      The latest gate of the stage.
    • members array[DeliveryMember] optional
      The members of the run.
    • ↳ id string required
      The ID of the member.
    • ↳ name string required
      The name of the member: the component and, for a group of stacks, the entry.
    • ↳ type enum required
      The type of the member.
      Values: job, stacks, artifact, agent
    • ↳ stageName string optional
      The name of the stage of the member.
    • ↳ targetStack DeliveryStackRef optional
      The stack that a member of Stacks updates.
    • ↳ status DeliveryStatus required
      The structured status of the member, with the reason it waits.
    • ↳ failureReason string optional
      Why the member failed. Free-form text.
    • ↳ agentTaskId string optional
      The Neo task that an Agent member started.
    • ↳ currentAttempt DeliveryAttempt optional
      The current attempt of the member.
    • ↳ group DeliveryMemberGroup optional
      The group of stacks of the member.
    • ↳ dependsOn array[string] optional
      The IDs of the members that this member waits for.
    • ↳ unchangedSinceRelease integer optional
      The release that last ran the member, for a member whose status is unchanged in a local run. Not set when unknown.
    • edges array[DeliveryEdge] optional
      The edges between the stages and between the members.
    • ↳ from string required
      The start of the edge: a stage name or a member ID.
    • ↳ to string required
      The end of the edge: a stage name or a member ID.
    • ↳ kind enum required
      The kind of the edge: stage or member.
      Values: stage, member
    • artifacts DeliveryRunArtifacts optional
      The artifacts that the run recorded.
    • ↳ runNumber integer required
      The number of the run.
    • ↳ artifacts map[string]DeliveryValue optional
      The artifacts by name.
    • actions DeliveryRunActions required
      The actions available to the caller.
    • ↳ retry DeliveryAction required
      Whether the caller can retry the run.
    • ↳ cancel DeliveryAction required
      Whether the caller can cancel the run.

      The infrastructure platform for humans and agents.