Skip to main content
← Back to list
01Issue
FeatureShippedSwamp Club
Assigneesstack72

Relationships

#1418 Documentation for workflow assert steps and JUnit output

Opened by stack72 · 7/26/2026· Shipped 7/27/2026

Context

PR #1970 adds assert steps and JUnit XML output to workflows. The user-facing documentation at swamp-club/swamp-club needs updating to cover the new feature.

What needs adding

Reference (content/manual/reference/)

Update workflows.md to document:

  • assert step task type — expr, message, severity fields
  • --fail-on <low|medium|high> flag on swamp workflow run
  • --junit and --out <file> flags for JUnit XML output
  • assertResult field on step run data (visible in --json output and workflow history get)

How-to guide (content/manual/how-to/)

New guide: "Verify infrastructure with assert steps"

  • Pattern: provision with model-method steps, collect live state, assert on collected data
  • Using data.latest() in CEL expressions to check prior step output
  • Setting severity levels and using --fail-on to control CI exit codes
  • Generating JUnit XML for CI test reporters (GitHub Actions, GitLab, Jenkins)
  • YAML quoting: when to use >- block scalars for CEL expressions containing double quotes

Explanation (content/manual/explanation/)

Add a section to the workflows explanation covering:

  • How assert steps fit into the workflow DAG — they run after data-producing steps via dependsOn
  • The collect-then-assert pattern vs throwing model-methods (why assert steps exist)
  • Severity levels and the --fail-on threshold model
  • How assert results persist to the datastore and are queryable after the run
02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED+ 1 MOREASSIGNED+ 4 MOREREVIEW+ 3 MOREPR_MERGED+ 1 MORENOTIFICATION_SKIPPED

Shipped

7/27/2026, 12:10:17 AM

Click a lifecycle step above to view its details.

03Sludge Pulse
stack72 assigned stack727/26/2026, 11:11:52 PM

Sign in to post a ripple.