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

Relationships

#613 Docs: Add release channel documentation to the manual

Opened by stack72 · 6/10/2026· Shipped 6/10/2026

Context

PR swamp-club/swamp#1552 adds release channel support (beta, rc, stable) to the extension system. The following manual pages need updates to document the new feature.

Pages to update

Reference: extensions.md (content/manual/reference/extensions.md)

Add a Release Channels section covering:

  • Three fixed channels: beta, rc, stable — with the promotion ladder diagram (beta to rc to stable, can skip rc)
  • Version uniqueness is global per extension regardless of channel — enables promotion as metadata-only operation
  • CalVer format is unchanged — channels are orthogonal metadata on versions

Reference: extensions/ subdirectory

If the extensions reference has sub-pages for individual commands, each of the following needs a --channel flag section:

  • push — --channel rc or --channel beta to push to a prerelease channel. Omitting means stable. Accepts a single value, validated to rc or beta.
  • pull — --channel rc or --channel beta to pull the latest prerelease version. Omitting means stable. Explicit version pinning (@name@version) ignores channel.
  • search — --channel rc --channel beta collect flag to filter results. Multiple values allowed. Omitting means stable-only results.
  • promote (new command) — swamp extension promote @name version --channel target. Target is rc or stable. Forward-only transitions enforced.
  • info — now shows per-channel latest versions (stable, rc, beta) when they exist. No flag needed.
  • version — shows per-channel latest and next bump when prerelease versions exist.

How-to: extensions.md (content/manual/how-to/extensions.md)

Add a how-to section for the CI/CD prerelease workflow:

  1. Push a beta: swamp extension push manifest.yaml --channel beta
  2. Pull beta in CI for integration testing: swamp extension pull @name --channel beta
  3. Promote beta to rc after tests pass: swamp extension promote @name version --channel rc
  4. Promote rc to stable after validation: swamp extension promote @name version --channel stable
  5. Default consumers continue getting stable: swamp extension pull @name (no change)

How-to: extensions/ subdirectory

If the how-to has sub-pages, add a "Publishing pre-release versions" guide covering the full workflow above with concrete examples.

Key UX details to document

  • --channel is consistent across all commands — same flag name everywhere
  • On push/pull it takes a single value (rc or beta)
  • On search it is a collect flag (multiple allowed: --channel rc --channel beta)
  • On promote, --channel specifies the target (rc or stable) — this is the only command where stable is explicitly named
  • Stable is the implicit default everywhere — you never say --channel stable on push or pull
  • Auto-resolve only considers stable versions — prerelease versions never auto-install
  • Lockfile records the installed channel — update checks stay within the installed channel
  • Dependencies resolve from stable regardless of the parent extension's channel
02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED+ 1 MOREASSIGNED+ 2 MOREREVIEW+ 3 MOREPR_MERGED+ 1 MORENOTIFICATION_SKIPPED

Shipped

6/10/2026, 9:38:32 PM

Click a lifecycle step above to view its details.

03Sludge Pulse
stack72 assigned stack726/10/2026, 9:05:15 PM

Sign in to post a ripple.