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

Relationships

#1332 Docs: update autoGc documentation to reflect write-time version pruning

Opened by stack72 · 7/21/2026

Context

PR #1921 gated write-time garbageCollection enforcement behind the autoGc flag. When autoGc: true, save() now prunes excess versions incrementally at write time — in addition to the existing batch GC after each model method run. The user-facing docs don't reflect this.

Files to update

content/manual/reference/data.md

  1. Line ~144 — "Garbage collection runs as part of swamp data gc and during the lifecycle service" should mention that autoGc: true also enables incremental write-time pruning.

  2. Line ~887 — The autoGc paragraph should note that it enables both batch GC after model runs AND incremental version pruning at write time.

content/manual/reference/repository-configuration.md

  1. Line ~328 — The autoGc section says GC runs "after each model method run completes". It should also mention that it enables incremental version pruning during data writes, so versions are capped at the declared garbageCollection policy as they are written.

Key behavior to document

  • autoGc: false (default): versions accumulate without limit. Enforcement only via explicit swamp data gc (with preview/confirmation).
  • autoGc: true: versions are pruned incrementally at write time AND batch-cleaned after each model method run. The user sees "Running auto-GC (autoGc is enabled in .swamp.yaml)" followed by a removal summary.
02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED

Open

7/21/2026, 10:43:05 PM

No activity in this phase yet.

03Sludge Pulse

Sign in to post a ripple.