Skip to main content
← Back to list
01Issue
FeatureOpenSwamp CLI
AssigneesNone

Relationships

#648 Docs: document reports.require failure semantics in the manual (unresolvable required report fails the run)

Opened by keeb · 6/13/2026

Filing here because GitHub issues are disabled on swamp-club/swamp-club (where the manual lives).

Gap

The manual documents the reports.require / reports.skip schema in content/manual/reference/model-definitions.md (### reports -> #### ReportSelection) and content/manual/reference/workflows.md (### reports), but neither describes what happens when a required report cannot be resolved, nor report behavior during swamp workflow resume.

A fix for #640 changes this behavior to be loud and explicit, so the reference should describe the contract.

Behavior to document

  1. Unresolvable required report fails the run. A name in reports.require that resolves to no loaded or installed report (missing extension pull, typo, broken bundle) now: logs a warning naming the report and the remedy (re-pull / swamp doctor extensions --repair), writes a searchable error artifact (visible via swamp report search), and counts as a report failure — which makes swamp model method run exit non-zero. Previously it was silently skipped with no error, warning, or artifact.
  2. reports.skip exempts a name from the above (skip wins over require).
  3. swamp workflow resume now runs reports. Resumed workflows previously skipped all workflow-scope and step-scope reports including reports.require; they now execute.

Suggested placement

  • content/manual/reference/model-definitions.md — under #### ReportSelection, add a "Required report resolution" note covering points 1 and 2.
  • content/manual/reference/workflows.md — under ### reports, note that required reports must resolve or the run fails, and that resumed runs execute reports.

Source of truth for the contract: design/reports.md in swamp-club/swamp ("Unresolvable Required Reports" and "Filter Options Are Optional" sections). Implemented in the PR that fixes #640.

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED

Open

6/13/2026, 4:35:14 PM

No activity in this phase yet.

03Sludge Pulse

Sign in to post a ripple.