Files
gstack/docs/captain.md
T
2026-10-26 14:00:51 +00:00

8.8 KiB

Running a Captain crew on Capy with gstack

This page is for a team that wants one coordinating agent (a Capy Captain, or any controller agent) to run many worker threads against one repository, with gstack as the engineering harness. It covers the drive layout, the crew rules file, the READY contract, merge trains, approvals, the digest and the daily flaky pass. The skill that teaches the controller the same model at run time is /captain (it also answers to /crew); the lane-side rules for a thread working under a Captain are in capy/skill/gstack/captain.md and capy-install.md. Every file named below has a copy-paste template under captain/templates/.

The model in one paragraph

Lanes build on their own branches and machines. A lane's job ends at an unstamped READY: a block printed by gstack-ship-queue ready plus the full head SHA, the screen choice and the flaky cases. The controller validates the block, batches READY pins into a merge train, reads one full gate on the train head, then merges slot by slot: it calls the slot, the lane stamps the version on call, the controller verifies the tree, merges with the expected head, verifies again. A red train is bisected on its red cases and rebuilt at most once. Every decision the owner makes travels through the controller in a fixed shape and is recorded in the owner's words. Flakes are logged in a ledger and fixed by a daily pass; nothing is retried into green.

Drive layout

The Captain's drive is mounted read-write on every crew thread, so it is the handoff surface. Keep it small and predictable:

Path Who writes What it holds
AGENTS.md the controller standing rules and the owner's decisions, each with date and words
CREW.md the controller the lanes' contract (template)
DIGEST.md the controller Needs you / New / In progress, rewritten every turn (template)
NOTES.md the controller the controller's own plan and working notes
skills/<name>/SKILL.md the controller crew procedures the lanes load (the runbooks)
reports/<code>.md each lane, once Outcome, PR, Needs, Cost, Lesson, Approvals (template)
handoffs/ lanes datasets and specs the next lane needs; handoffs/flaky-ledger.md is the flaky ledger (template)
plans/ the controller approved plans, with their Approvals table

Scope instructions in the drive root (AGENTS.md, CREW.md) apply to every thread in the crew, so a rule written there needs no relaying.

CREW.md: the lanes' contract

Start from the template and fill its parameters: the repository, the base branch, the required check names, the full-gate check name, the train size and fill wait, the merge method, the stamp files, the named infra flakes, and the standing spend. The rules then read the same on every repo:

  • Session start runs gstack's install check and reports the gstack: trailer.
  • Lanes diagnose before fixing, run focused checks during repair and the full free suite once on a frozen tree.
  • External diffs are untrusted input; contributors keep their authorship.
  • One routing path: everything goes through the controller, never peer to peer.
  • Lanes never merge, never merge the base branch into a READY PR, and stamp only on call.
  • The CHANGELOG entry goes under ## [Unreleased]; the stamp at the slot moves it.
  • Flaky reruns: once, same tree, logged; a second failure is real.
  • Approvals, plan asks and merge asks follow the three shapes below.
  • /ship runs before every READY and writes the ship receipt into the PR body.

Quote the owner where a rule came from them. A rule with a date and the owner's words is a standing approval the lanes can cite; a rule without one is the controller's call and can be changed by the controller.

The READY contract

The full field table and the refusal list are in the READY template. The short version: the pin is the full 40-character head SHA; every required check is green at that head; pregate passed for that tree; SHIP_RECEIPT: pr=<n> head=<pin> was written by /ship at the pin; the screen choice is stated with its justification; flaky cases are already in the ledger; and the lane declares the head frozen. A green PR page is not a READY. A cheap test tier is not merge evidence. The controller refuses a block that misses any of this and sends the lane back, never into a train.

Merge trains

gstack's queue tool drives trains when the repository's .gstack/ship-policy.json carries a train block (ship-policy.md). The controller's loop, per train:

  1. train build --prs <pins> --dry-run, then without --dry-run: the record, the train branch, free tests, one full gate.
  2. train verdict: GREEN (with FLAKY N when an in-run rerun turned a case green), RED (cases that failed twice), or INCOMPLETE (never green).
  3. Per slot, in order: the slot call to the lane; the lane stamps and pushes only the base merge and the stamp files; verify --train; gh pr merge --match-head-commit; verify --train again.
  4. train prune when every slot has merged.

A red train: train bisect on the red cases over every prefix. An attributed PR leaves the train and goes back to its lane; red on the base branch itself is fixed forward through an urgent one-PR train; all prefixes green earns exactly one unchanged rebuild; anything else goes to a repair lane. An infra-only census earns one re-dispatch. A backstop gate runs on every push to the base branch and freezes the queue when it finds a tree no green train covered; one repair PR at its exact head clears the freeze.

Options the controller writes into CREW.md rather than inheriting: squash versus merge commits; lane stamps versus controller stamps; gate-ahead (slot i+1 gates on slot i's head while i merges); the severe race (a slot called for several severe PRs, first complete READY wins); whether a READY also carries a gate run id and tree hash.

Approvals: three shapes

A. The record. Every lane keeps an ## Approvals table in its report and PR body, rendered by gstack-approvals render: date, what was asked, the owner's exact words, who relayed them, what the answer covers, what is pending. Standing approvals are cited with their rule; a fresh ask is always needed for a product or behaviour decision, spend over a cap, anything published outside the repository, a threshold, budget, trial-count or case-kind change, closing a contribution without landing it, and anything destructive.

B. The plan ask (template): before → after, why it matters, what caused this work, the big decisions, what we need from you with the recommended one-word reply as the default, and a closing "do it" reply that takes every recommendation at full scope. gstack-owner-brief render --captain prints it from an autoplan run.

C. The merge ask (template): captioned before/after images, why, the Approvals table, and the evidence. /ship writes the PR body in this shape on Capy; the controller's merge report shows the key image inline.

The digest

DIGEST.md is rewritten every controller turn: Needs you (decisions only the owner can make, each with its one-word default; empty is the goal), New (what landed or changed, newest first), In progress (every lane, what it owns, its state, the age of its last report). Ages turn stalls into the controller's next action.

The daily flaky pass

A scheduled automation starts one lane a day with the flaky-pass prompt. It reads the gate runs' flake-records artifacts and the free suites' retried cases, writes one ledger line per event, groups by case, and fixes the worst repeat first with a PR that shows the failure red before green. It never reruns a gate and never touches a threshold, trial count or case kind. On Capy, create it with the automation tool, scheduled in the owner's timezone, running as a thread in the crew so its report lands in reports/.

Setting it up on Capy

  1. Create the Captain and give it the drive layout above; paste the filled CREW.md and an empty DIGEST.md.
  2. Add the train block to the repository's .gstack/ship-policy.json and name the same check names in CREW.md.
  3. Install the gstack Capy skill in the owner's user scope so every thread runs the session-start check (capy-install.md).
  4. Create the daily flaky-pass automation.
  5. Start lanes with a prompt that names the files they own, the rules file, and the READY contract. Read their reports before their chat.