serve · diff
git:20260906.f99ce94 to git:20260919.26a1432
55 added, 24 removed. Audit A to A.
---
name: serve
- description: Write and create issues for approved nutrients with trace and deduplication markers, using crab serve. Use when serving a menu, writing the why and how of a nutrient, explaining the trace footer, or checking why a nutrient was skipped.
+ description: Write and create issues or guarded pull requests for approved nutrients with trace and deduplication markers, using crab serve. Use when serving a menu, writing the why and how of a nutrient, explaining the trace footer, or checking why a nutrient was skipped.
---
# Serve nutrients
- `crab serve` creates the issues; you write the two sentences that make them worth reading.
+ `crab serve` creates issues or, for completed clean-room REIMPLEMENT nutrients, guarded pull requests. You write the two sentences that make them worth reading.
## Notes file
Before serving, write `notes.json` with one entry per nutrient you keep:
```json
[
{
"id": "crab:ci:ci.cache",
"why": "Every CI run reinstalls the dependencies; the prey's cache step cuts its lint job to 12 seconds.",
"how": "Add `enable-cache: true` to astral-sh/setup-uv in ci.yml, keyed on uv.lock; run it on one PR before enabling it for the matrix."
}
]
```
Rules for `why` and `how`:
- Name a concrete effect in this repository (time, risk, a class of bugs), not a generic benefit.
- `how` names files and tools of the maw, adapted to its toolchain; it is the first step, not a
full plan.
- Never paste prey text unless the license mode is `COPY`; even then cite the path.
- Optional fields: `title` (if the generated one is off), `serve_as`, `effort`, `risk`.
## Commands
```bash
crab serve <prey> --maw . --ids id1,id2 --notes notes.json --as dry-run # previews
- crab serve <prey> --maw . --ids id1,id2 --notes notes.json --as issue # creates
+ crab serve <prey> --maw . --ids id1,id2 --notes notes.json --as issue # creates issues
crab serve <prey> --maw . --top 5 --as dry-run # top of the menu
+ cat receipt.json | crab serve <prey> --maw . --ids id1 --notes notes.json --as pr-branch
```
- Dry-run is the default; show the previews and get a confirmation before `--as issue`.
- - `serve.issues: off` in `.crab.yml` blocks creation; `auto` allows it in CI without asking.
- - The maw must have a GitHub `origin` remote; `gh` must be authenticated.
+ - `serve.issues: off` in `.crab.yml` blocks issue creation; `auto` allows it in CI without asking.
+ - `serve.prs: off` blocks pull-request publication; `ask` requires explicit `--ids`, while `auto`
+ permits ranked selection such as `--top`.
+ - Pull-request mode accepts the strict JSON implementation receipt returned by
+ `crab-cleanroom-impl` on **stdin**. For a batch, concatenate the complete JSON documents with
+ whitespace between them. The receipt stream is transport only: Hungry Crab does not persist it
+ as a second PR state store.
+ - Each selected REIMPLEMENT nutrient must have exactly one receipt. The receipt's own
+ `nutrient_id` binds it to the menu card; missing, duplicate, malformed, stale, non-UTF-8, missing
+ or maw-escaping declared files fail closed before provider effects.
+ - COPY pull-request serving remains blocked until its attribution/materialization contract lands;
+ do not route it through the clean-room REIMPLEMENT path.
+ - The maw must have a GitHub `origin` remote; `gh` must be authenticated. Pull-request publication
+ also requires the maw to be a git repository with its `origin` fetchable.
- ## Whose name the issues carry
+ ## Pull-request transaction
- Issues go into **the maw**, so serving into another repository means digesting that repository
- as the maw: `crab serve <prey> --maw ../their-repo`. It needs a working tree, because the
- comparison is against real files.
+ `--as pr-branch` does not publish the current dirty diff. It consumes only the exact paths in the
+ clean-room receipt, freezes their current UTF-8 bytes, and then follows the guarded transaction:
- By default the issues are filed as whoever `gh` is logged in as. `serve.token_env` in that
- repository's `.crab.yml` names an environment variable holding a token to use instead — a
- GitHub App installation token, or a machine account's — and then the issues carry the crab's
- name rather than a person's. The first log line of `--as issue` says which identity is in use;
- read it back to the user before confirming.
+ 1. prepare **all** selected nutrients into immutable payloads;
+ 2. scan every file plus PR title/body for possible secrets;
+ 3. reconcile marker-bearing PRs already present on GitHub;
+ 4. only then create/reuse the deterministic nutrient branch and create the PR;
+ 5. write the provider URL to the ledger after GitHub returns it.
- Opening an issue needs no special permission on a public repository, but **creating a label
- needs write access**. Where the crab cannot create its label it says so once and serves without
- labels; deduplication is unaffected, because it reads the `crab:<id>` marker in the body, not
- the label.
+ The branch effect uses a detached temporary worktree and stages the frozen bytes without repository
+ clean filters. A rerun after a successful PR but failed ledger save reconciles the existing PR by
+ its opening `<!-- crab:<id> -->` marker instead of creating a duplicate. `max_prs_per_run` counts
+ new PRs only; reconciliation does not spend creation budget.
+ ## Whose name the artifacts carry
+
+ Issues and pull requests go into **the maw**, so serving into another repository means digesting
+ that repository as the maw: `crab serve <prey> --maw ../their-repo`. It needs a working tree,
+ because the comparison and guarded PR publication operate against real maw files.
+
+ By default artifacts are filed as whoever `gh` is logged in as. `serve.token_env` in that
+ repository's `.crab.yml` names an environment variable holding a token to use instead — a GitHub
+ App installation token, or a machine account's — and then artifacts carry the crab's name rather
+ than a person's. The first log line of an effectful serve says which identity is in use; read it
+ back to the user before confirming.
+
+ Opening an issue needs no special permission on a public repository, but **creating a label needs
+ write access**. Where the crab cannot create its label it says so once and serves without labels;
+ deduplication is unaffected, because it reads the `crab:<id>` marker in the body, not the label.
+
## What an issue contains
See `references/issue-template.md`. Every issue carries a hidden `<!-- crab:<id> -->` marker
- (deduplication across runs and machines), the `hungry-crab` label, and a trace footer with
- prey, commit, license and mode. The ledger records `served` with the issue URL.
+ (deduplication across runs and machines), the `hungry-crab` label, and a trace footer with prey,
+ commit, license and mode. The ledger records `served` with the issue URL.
+ Pull requests carry the same opening marker and trace, plus the clean-room implementation summary.
+ The files are exactly the receipt-declared, hash-verified publication payload; unrelated dirty maw
+ files are not discovered or added.
+
## Skips and their meaning
| Reason | Meaning |
|---|---|
| `ledger: rejected (...)` | decided earlier; do not re-propose unless the user asks |
- | `ledger: served <url>` | already an issue; link to it |
+ | `ledger: served <url>` | already served; link to it |
| `issue #N exists (open)` | found by marker on GitHub; the ledger is updated |
+ | `pull request exists <url>; ledger reconciled` | provider already has the PR; local truth was repaired without creating another |
+ | `serve.max_prs_per_run reached (N)` | creation budget is exhausted; an already-existing PR could still have reconciled |
| `not in the menu` | run `crab compare` again or check the id |
-
- Pull-request serving (`--as pr-branch`) arrives with milestone 0.3; until then serve `pr`
- nutrients as issues and say so in the report.