PipelineRunView

Shape

• edgesarray of ResolvedEdgeThe connections between the run's steps, so a client can draw its graph. Each one feeds an output port of from_node into an input port of to_node.

  • The ResolvedEdge schema
  • from_nodeNodeId (string)
  • to_nodeNodeId (string)
  • from_portPortName (string) or nulloptionalAbsent on a dependency-only connection — one that orders two steps and carries nothing.
  • to_portPortName (string) or nulloptionalAbsent on a dependency-only edge.
• last_event_idEventId (string · uuid)
• nodesarray of NodeView

  • The NodeView schema
  • attemptinteger · int320–∞
  • capability_idCapabilityId (string)The capability this step runs, as {provider}:{name} (e.g. docker:build).
  • historyarray of NodeAttemptRecordEarlier attempts of this step after retries, oldest first.

    • The NodeAttemptRecord schema
    • attemptinteger · int320–∞
    • finished_atstringWhen the attempt ended, RFC 3339.
    • node_run_idNodeRunId (string · uuid)
    • statusNodeStatuspendingawaiting_approvaldispatchedrunningsucceededfailedtimed_outskippedcancelledWhere a step has got to.
    • exit_codeinteger · int32 or nulloptional
  • logs_hrefstringRelative URL of this step's logs.
  • node_idNodeId (string)
  • node_run_idNodeRunId (string · uuid)
  • provider_idProviderId (string)The provider that runs this step (e.g. docker), as chosen from the catalog when the run started.
  • stage_idStageId (string)
  • stage_indexinteger · int320–∞
  • statusNodeStatuspendingawaiting_approvaldispatchedrunningsucceededfailedtimed_outskippedcancelledWhere a step has got to.
  • allow_failurebooleanoptionalThe author marked this step as allowed to fail: if it fails or times out, the stage and the run carry on (the run ends succeeded_with_warnings) and only the steps that depend on it are skipped. Show such a failure as a warning.
  • duration_msinteger · int64 or nulloptional0–∞
  • error_summarystring or nulloptionalWhy the step failed, skipped, timed out or was cancelled, in a sentence or two. For a step that failed after it ran, the same text as failure describes.
  • exit_codeinteger · int32 or nulloptional
  • failureNodeFailure or nulloptionalWhy a step that ran failed, as a cause a client can act on. Absent for a step that succeeded or never ran.
  • finished_atstring or nulloptional
  • namestringoptionalThe step's display name, as the pipeline's author wrote it when the run started. Empty for older runs recorded without one; show the capability instead.
  • originNodeOrigin or nulloptionalThe component this step was expanded from, when the author wrote a component instance rather than the step itself. Absent for a step the pipeline declares directly, and for runs that predate this field.

    • The NodeOrigin schema
    • component_idComponentId (string · uuid)
    • component_nameComponentName (string)
    • inner_node_idNodeId (string)This node's identifier inside the component body — what its author called it, before expansion prefixed it with the instance.
    • instance_idNodeId (string)The component instance in the pipeline the author wrote.
    • versionComponentVersion (string)The version the instance's reference resolved to.
  • retry_afterstring or nulloptionalWhen the platform next checks whether a held step can start, RFC 3339 — the wait timer's expiry, or the next check of the concurrency lock. Absent when nothing is scheduled, including while waiting for an approval, which a person gives rather than a clock.
  • started_atstring or nulloptional
  • waiting_onNodeWaitKindapprovalwait_timerconcurrency_lockor nulloptionalWhy a step that has not started is being held: it is waiting for an approval, for an environment's wait timer, or for another run to release its concurrency lock. Absent for a step that is simply waiting for the steps before it.
• pipeline_namestring
• pipeline_run_idPipelineRunId (string · uuid)
• repo_idRepositoryId (string · uuid)
• stagesarray of StageViewThe run's stages in execution order, each with how many of its steps have finished and failed.

  • The StageView schema
  • barrier_passedbooleanWhether every step in the stage has finished, so later stages may start.
  • failed_countinteger · int320–∞Steps in the stage that failed or timed out, not counting steps allowed to fail.
  • stage_idStageId (string)
  • stage_indexinteger · int320–∞The stage's position in execution order, counting from zero.
  • terminal_countinteger · int320–∞Steps in the stage that have finished, whatever their outcome.
  • totalinteger · int320–∞Steps in the stage.
• started_atstring
• statusPipelineStatusrunningsucceededsucceeded_with_warningsfailedtimed_outcancelledPer-PipelineRun status.
• triggerTriggerContext

  • The TriggerContext schema
  • repo_idRepositoryId (string · uuid)
  • repo_pathstring
  • before_shastring or nulloptionalThe commit the ref pointed at before the push — what a paths filter compares against. On a run started by hand, the commit its starter named to compare from, if any.
  • branchstring or nulloptional
  • buildMrBuildTargetmerge_resultsourceor nulloptionalWhich commit a merge-request-triggered run built.
  • commit_shastring or nulloptional
  • depthinteger · int32optional0–∞How many pushes made by pipeline runs led to this run, one after another; 0 when no pipeline's push started it.
  • every_stepbooleanoptionalEvery step runs, whatever its path filter says — asked for by whoever started the run.
  • extraobjectoptionalAdditional fields supplied by whatever started the run, passed along without being interpreted.
  • kindTriggerKindpushmerge_requesttagschedulemanualoptionalWhat started this run.
  • mr_idMergeRequestId (integer · int64) or nulloptional
  • paramsobjectoptionalThe values a person supplied when starting the run, keyed by the parameter names the pipeline's manual trigger declares.
  • ref_namestring or nulloptionalThe full ref (e.g. refs/tags/v1.2.0). Set for runs a tag started, which branch cannot describe.
  • root_group_idGroupId (string · uuid) or nulloptionalThe organisation this run belongs to — the root group of the repository it was triggered for. Recorded when the run starts and never recalculated, so a repository moved to a different organisation part-way through a run keeps the artifacts, logs and cache it has already produced. Absent on runs that started before runs recorded this.
  • schedule_stemstring or nulloptionalWhich scheduled trigger fired, when kind is schedule.
  • source_shastring or nulloptionalThe source-branch commit this run tested: a merge request's source head for a merge-request run, whichever commit it built, and the commit itself for a push or manual run. Set by the platform; absent on a run whose graph the caller supplied, which never counts toward a merge request's pipelines.
  • target_branchstring or nulloptionalThe merge request's target branch.
  • target_shastring or nulloptionalThe target branch's tip this merge-request run was tested against. Once the target branch moves on, the merge check reports a merge-result run as out of date.
  • triggered_byActorSummaryoptionalWho started the run, set by the platform from the authenticated caller; a value supplied in a request is ignored.

    • The ActorSummary schema
    • emailstring
    • idstring
    • usernamestring
    • avatar_urlstring or nulloptional
  • trustTriggerTrusttrusteduntrustedoptionalWhether the code being built is trusted with the repository's connections and secrets. Set by the platform when the run starts, whatever a request says.
  • trust_reasonTrustReason or nulloptionalWhy the run has the trust it has: who wrote the code, a person's merge or approval, or the organization's AI configuration. Absent on runs that started before this was recorded.
• versioninteger · int640–∞
• finished_atstring or nulloptional
• pipeline_idPipelineId (string · uuid) or nulloptionalThe pipeline definition this run was started from. Absent when that definition has since been deleted; pipeline_name still names what ran.
• re_run_ofPipelineRunId (string · uuid) or nulloptional

Graph

Used by