Liking cljdoc? Tell your friends :D

bridge.summary

Canonical machine-readable status summary.

This is the single flattened projection of bridge.next/build-status that all machine consumers share: bb bridge check --format json prints it, bridge.api/check returns it. The shape carries a :summary-version so consumers can detect evolution explicitly.

Required obligations are failed-first then open, each obligation is flattened with its evidence kinds and first runnable command, and fresh evidence-run receipts are listed with normalized fields.

Canonical machine-readable status summary.

This is the single flattened projection of bridge.next/build-status
that all machine consumers share: `bb bridge check --format json`
prints it, bridge.api/check returns it. The shape carries
a :summary-version so consumers can detect evolution explicitly.

Required obligations are failed-first then open, each obligation is
flattened with its evidence kinds and first runnable command, and
fresh evidence-run receipts are listed with normalized fields.
raw docstring

flatten-obligationclj

(flatten-obligation obligation)

Flatten one build-status obligation into the canonical shape: :kind, :subject, :artifact, :summary, :reason, :state, :required-evidence, :actions, plus :evidence-kinds (vector), :evidence-kind (only when exactly one kind), and :command (first runnable action, only when actions exist).

Flatten one build-status obligation into the canonical shape:
`:kind`, `:subject`, `:artifact`, `:summary`, `:reason`, `:state`,
`:required-evidence`, `:actions`, plus `:evidence-kinds` (vector),
`:evidence-kind` (only when exactly one kind), and `:command` (first
runnable action, only when actions exist).
sourceraw docstring

status-summaryclj

(status-summary status)

Project a bridge.next/build-status result into the canonical machine-readable summary:

{:summary-version 2 :project :status :issue-count :changed-files :change-detection :counts {:required-obligations :recommended-obligations :stale-artifacts :subject-problems :receipts :passed-receipts} :required-obligations [...] ; flattened, failed first then open :recommended-obligations [...] ; flattened :stale-artifacts [...] :subject-problems [...] :evidence-receipts [...] :convergence-summary {...} :next-action {...}|nil} ; first runnable action, failed first

This function is a pure projection of the supplied status.

Project a bridge.next/build-status result into the canonical
machine-readable summary:

  {:summary-version 2
   :project :status :issue-count :changed-files :change-detection
   :counts {:required-obligations :recommended-obligations
            :stale-artifacts :subject-problems
            :receipts :passed-receipts}
   :required-obligations [...]    ; flattened, failed first then open
   :recommended-obligations [...] ; flattened
   :stale-artifacts [...]
   :subject-problems [...]
   :evidence-receipts [...]
   :convergence-summary {...}
   :next-action {...}|nil}        ; first runnable action, failed first

This function is a pure projection of the supplied status.
sourceraw docstring

summary-versionclj

Version of the canonical status-summary shape. Bump on any change to field names, nesting, or semantics, with a CHANGELOG entry.

Version of the canonical status-summary shape. Bump on any change to
field names, nesting, or semantics, with a CHANGELOG entry.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close