docs: add kubernetes, ssh, and mini-shai-hulud to README #9

Merged
stack72 merged 1 commit from worktree-prancy-soaring-micali into main 2026-05-28 00:41:28 +00:00
Owner

Summary

  • Adds the @swamp/kubernetes extension to the README with its own section, covering 15 model types and 14 workflows for Kubernetes operational tasks
  • Adds the @swamp/ssh extension to the README with its own section, covering SSH fleet management with OpenSSH ControlMaster and Tailscale transport support
  • Adds @swamp/cve/mini-shai-hulud to the existing CVE Extensions table for the May 2026 npm supply chain attack scanner (317 compromised packages)
  • Adds all three extensions to the Installation section with their swamp extension pull commands

Impact

These three extensions already exist in the repo and are published, but were missing from the root README. Users browsing the repository had no way to discover them from the main documentation page. This change makes them visible alongside all other extensions.

Why this is correct

  • Each entry's description and dependencies were taken directly from the extension's manifest.yaml
  • SSH and Kubernetes get their own sections (like the existing CVE section) since they are hand-written extensions with unique capabilities, not auto-generated model extensions
  • Mini Shai-Hulud is added to the existing CVE table since it follows the same pattern as @swamp/cve/dirtyfrag
  • Installation commands follow the existing format exactly

🤖 Generated with Claude Code

## Summary - Adds the `@swamp/kubernetes` extension to the README with its own section, covering 15 model types and 14 workflows for Kubernetes operational tasks - Adds the `@swamp/ssh` extension to the README with its own section, covering SSH fleet management with OpenSSH ControlMaster and Tailscale transport support - Adds `@swamp/cve/mini-shai-hulud` to the existing CVE Extensions table for the May 2026 npm supply chain attack scanner (317 compromised packages) - Adds all three extensions to the Installation section with their `swamp extension pull` commands ## Impact These three extensions already exist in the repo and are published, but were missing from the root README. Users browsing the repository had no way to discover them from the main documentation page. This change makes them visible alongside all other extensions. ## Why this is correct - Each entry's description and dependencies were taken directly from the extension's `manifest.yaml` - SSH and Kubernetes get their own sections (like the existing CVE section) since they are hand-written extensions with unique capabilities, not auto-generated model extensions - Mini Shai-Hulud is added to the existing CVE table since it follows the same pattern as `@swamp/cve/dirtyfrag` - Installation commands follow the existing format exactly 🤖 Generated with [Claude Code](https://claude.com/claude-code)
docs: add kubernetes, ssh, and mini-shai-hulud to README
All checks were successful
CI / workflows/gcs-bootstrap - fmt (pull_request) Has been skipped
CI / workflows/s3-bootstrap - fmt (pull_request) Has been skipped
CI / workflows/gcs-bootstrap - lint (pull_request) Has been skipped
CI / workflows/s3-bootstrap - lint (pull_request) Has been skipped
CI / workflows/gcs-bootstrap - test (pull_request) Has been skipped
CI / workflows/s3-bootstrap - test (pull_request) Has been skipped
CI / workflows/gcs-bootstrap - lockfile up to date (pull_request) Has been skipped
CI / workflows/s3-bootstrap - lockfile up to date (pull_request) Has been skipped
CI / cve/dirtyfrag - fmt (pull_request) Has been skipped
CI / cve/dirtyfrag - lint (pull_request) Has been skipped
CI / cve/dirtyfrag - test (pull_request) Has been skipped
CI / cve/mini-shai-hulud - check (pull_request) Has been skipped
CI / cve/mini-shai-hulud - test (pull_request) Has been skipped
CI / cve/mini-shai-hulud - lockfile up to date (pull_request) Has been skipped
CI / model/digitalocean - check (pull_request) Has been skipped
CI / model/hetzner-cloud - check (pull_request) Has been skipped
CI / model/digitalocean - lockfile up to date (pull_request) Has been skipped
CI / model/hetzner-cloud - lockfile up to date (pull_request) Has been skipped
CI / aws models - lockfiles up to date (pull_request) Has been skipped
CI / gcp models - lockfiles up to date (pull_request) Has been skipped
CI / gcp models - sample check (pull_request) Has been skipped
CI / codegen - check (pull_request) Has been skipped
CI / codegen - lint (pull_request) Has been skipped
CI / codegen - fmt (pull_request) Has been skipped
CI / codegen - lockfile up to date (pull_request) Has been skipped
CI / Dependency Audit (pull_request) Successful in 4m24s
CI / Adversarial Code Review (pull_request) Has been skipped
CI / CI Security Review (pull_request) Has been skipped
CI / Claude Code Review (pull_request) Successful in 2m7s
CI / Merge Gate (pull_request) Successful in 28s
280a51fdc1
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Author
Owner

Code Review

Blocking Issues

None.

Suggestions

  1. Stale count in mini-shai-hulud description (line 36): The description hard-codes "317 packages compromised in the May 2026 'Mini Shai-Hulud' supply chain attack". Supply chain attack package counts frequently change as more compromised packages are discovered. Consider linking to a maintained advisory or omitting the count to avoid the README becoming misleading over time.

  2. Inconsistent section heading plurality (lines 38, 44): "SSH Extension" and "Kubernetes Extension" are singular, while every other section heading in the file uses the plural form ("Vault Extensions", "Datastore Extensions", "Workflow Extensions", "CVE Extensions"). Consider making these plural for consistency.

## Code Review ### Blocking Issues None. ### Suggestions 1. **Stale count in `mini-shai-hulud` description** (line 36): The description hard-codes "317 packages compromised in the May 2026 'Mini Shai-Hulud' supply chain attack". Supply chain attack package counts frequently change as more compromised packages are discovered. Consider linking to a maintained advisory or omitting the count to avoid the README becoming misleading over time. 2. **Inconsistent section heading plurality** (lines 38, 44): "SSH Extension" and "Kubernetes Extension" are singular, while every other section heading in the file uses the plural form ("Vault Extensions", "Datastore Extensions", "Workflow Extensions", "CVE Extensions"). Consider making these plural for consistency.
Author
Owner

Code Review

This PR adds a new README.md file documenting the full set of extensions (vault, datastore, workflow, CVE, SSH, Kubernetes, and auto-generated model extensions).

Blocking Issues

None.

Suggestions

  1. CLAUDE.md / README codegen command mismatch — The README's Code Generation section documents deno task fetch-schema:cloudflare and deno task generate:cloudflare, but the Commands section in CLAUDE.md lists only aws, gcp, hetzner, and digitalocean. The README appears more current (the model table references @swamp/cloudflare/*), so CLAUDE.md likely needs a follow-up update to include Cloudflare. Not a blocker since this PR only touches README.md.

  2. SSH and Kubernetes sections use singular headings (## SSH Extension, ## Kubernetes Extension) while all other categories use plural (## Vault Extensions, ## CVE Extensions, etc.). Minor style inconsistency — either pluralise the two or document the distinction between single-extension vs multi-extension sections.

  3. Kubernetes table row is very wide in raw Markdown — the description cell is ~290 characters, making the table difficult to read in a text editor or code review diff view. Consider splitting the description into two shorter sentences.

## Code Review This PR adds a new `README.md` file documenting the full set of extensions (vault, datastore, workflow, CVE, SSH, Kubernetes, and auto-generated model extensions). ### Blocking Issues None. ### Suggestions 1. **CLAUDE.md / README codegen command mismatch** — The README's Code Generation section documents `deno task fetch-schema:cloudflare` and `deno task generate:cloudflare`, but the Commands section in `CLAUDE.md` lists only aws, gcp, hetzner, and digitalocean. The README appears more current (the model table references `@swamp/cloudflare/*`), so `CLAUDE.md` likely needs a follow-up update to include Cloudflare. Not a blocker since this PR only touches `README.md`. 2. **SSH and Kubernetes sections use singular headings** (`## SSH Extension`, `## Kubernetes Extension`) while all other categories use plural (`## Vault Extensions`, `## CVE Extensions`, etc.). Minor style inconsistency — either pluralise the two or document the distinction between single-extension vs multi-extension sections. 3. **Kubernetes table row is very wide in raw Markdown** — the description cell is ~290 characters, making the table difficult to read in a text editor or code review diff view. Consider splitting the description into two shorter sentences.
stack72 deleted branch worktree-prancy-soaring-micali 2026-05-28 00:41:28 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
swamp-club/swamp-extensions!9
No description provided.