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

Relationships

#1404 Docs: document datastore directory relocation during setup

Opened by stack72 · 7/25/2026

Context

Documentation gap identified in swamp-club#1278. When swamp datastore setup is run on a repo with existing data, runtime directories (data, outputs, workflow-runs, etc.) are relocated from .swamp/ to the datastore path. The CLI now prints where directories moved (as of the fix PR), but the manual should also document this behavior.

What needs updating

The datastore-configuration.md reference page in the manual should include a section explaining:

  1. Which directories are relocated when a datastore is enabled (the DEFAULT_DATASTORE_SUBDIRS list minus ALWAYS_LOCAL_SUBDIRS)
  2. Where they move to:
    • Filesystem: the configured path
    • Extension (e.g., @swamp/s3-datastore): the local cache at ~/.swamp/repos/{repoId}/
  3. That the setup command prints the relocation details in its output
  4. That code hardcoding .swamp/workflow-runs/ or similar paths will break — use CLI commands (swamp workflow run search --json, swamp data get) instead
  • #1278 (original issue)
  • #1248 (related docs gap)

Automoved by swampadmin from https://github.com/swamp-club/swamp/issues/1964

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED

Open

7/25/2026, 9:14:02 PM

No activity in this phase yet.

03Sludge Pulse

Sign in to post a ripple.