@jagreehal/shepherd 0.12.0 → 0.12.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jagreehal/shepherd",
3
- "version": "0.12.0",
3
+ "version": "0.12.2",
4
4
  "description": "Agent skills that drive a PR to merge-ready: a review swarm, thread triage, CI repair, and a loop that hands the result to stamp.",
5
5
  "license": "MIT",
6
6
  "repository": "github:jagreehal/shepherd",
@@ -473,8 +473,20 @@ The verdict is advice to the author. It never becomes a GitHub approval.
473
473
 
474
474
  Write the round as JSON first (`references/formats.md`): the inline review and
475
475
  the summary are both rendered from it, so neither is ever hand-written Markdown.
476
- With `$SHEPHERD_HANDOFF` set, write it to `$SHEPHERD_HANDOFF/round.json` and
477
- stop here: the publish job renders and posts both. Otherwise post every inline finding as **one** review, pinned to the reviewed commit:
476
+ With `$SHEPHERD_HANDOFF` set, write it to `$SHEPHERD_HANDOFF/round.json`,
477
+ then check it before you stop:
478
+
479
+ ```bash
480
+ shepherd summary "$SHEPHERD_HANDOFF/round.json" --body > /dev/null
481
+ ```
482
+
483
+ It prints every field the renderer rejects on stderr, so keep stderr visible.
484
+ Fix `round.json` and run it again until it prints nothing. The workflow runs
485
+ the same check after you stop. The round is its own shape (`references/formats.md`):
486
+ not the Step 8 report (`posted`, `counts`, `narration`) and not the local
487
+ record (`stages`, `candidates`). `verdict` is `blocked`, `changes`, `nits` or
488
+ `good`; `verified` is the text of what the verifier checked. Then stop: the
489
+ publish job renders and posts both. Otherwise post every inline finding as **one** review, pinned to the reviewed commit:
478
490
 
479
491
  ```bash
480
492
  shepherd inline round.json > review.json
@@ -83,7 +83,8 @@ left, 1 or 0 a HIGH or CRITICAL standing. `effort` is how long a careful human
83
83
  read takes, 1 (a minute) to 5 (an hour or more). Draw a `diagram` only when the
84
84
  change has a flow a reader would otherwise reconstruct (a request path, a state
85
85
  machine, data moving between modules); leave it empty for a helper function.
86
- The new fields are optional: a round without them renders as before.
86
+ The new fields are optional: a round without them renders as before. A field
87
+ written as `null` reads as absent and takes its default.
87
88
  The renderers hold the round to what they can check. A `url`, `reintroduces`
88
89
  or still-open link that names no review comment on the PR, or is not a
89
90
  GitHub URL, loses its link.
package/src/summary.ts CHANGED
@@ -10,51 +10,74 @@ const Severity = z.enum(["CRITICAL", "HIGH", "MEDIUM", "LOW", "NIT"]);
10
10
 
11
11
  const THREAD_URL = /^https:\/\/github\.com\/[\w./#-]+$/;
12
12
 
13
+ // A model writing the round borrows words from swarm's other JSON shapes (the Step 8 report, the local record):
14
+ // `changes_needed`, `skipped`, `verified: true`. Each maps onto the round's own value, so a near miss still renders.
15
+ const alias = (table: Record<string, string>) => (v: string) => table[v.trim().toLowerCase().replaceAll(/[\s-]+/g, "_")] ?? v;
16
+
17
+ // Models write `null` for a field they have nothing for. Null reads as absent, so the field takes its default.
18
+ const absent = <T extends z.ZodType>(t: T) => t.nullish().transform((v) => v ?? undefined);
19
+
20
+ const text = z.string().nullish().transform((v) => v ?? "");
21
+
22
+ const flag = (fallback: boolean) => z.boolean().nullish().transform((v) => v ?? fallback);
23
+
24
+ const VERDICT_ALIAS = alias({ changes_needed: "changes", approve_with_nits: "nits", looks_good: "good", approve: "good", approved: "good" });
25
+
26
+ const STATUS_ALIAS = alias({ success: "ok", done: "ok", completed: "ok", complete: "ok", passed: "ok", error: "failed", errored: "failed", skipped: "could_not_run", not_run: "could_not_run", did_not_run: "could_not_run", missing: "could_not_run" });
27
+
13
28
  const Finding = z.object({
14
- file: z.string().default(""),
15
- line: z
16
- .union([
29
+ file: text,
30
+ line: absent(
31
+ z.union([
17
32
  z.number().int().positive(),
18
33
  z
19
34
  .string()
20
35
  .regex(/^(?:[1-9]\d*(?:-[1-9]\d*)?|general)$/)
21
36
  .refine((l) => !l.includes("-") || Number(l.split("-")[0]) <= Number(l.split("-")[1]), "a range runs start-end, start first"),
22
- ])
23
- .optional(),
37
+ ]),
38
+ ),
24
39
  severity: Severity,
25
40
  lens: z.string(),
26
41
  body: z.string(),
27
- convergent: z.boolean().default(false),
42
+ convergent: flag(false),
28
43
  // A reader triages by the title alone: a claim they can check, such as "`firstName` returns the second word".
29
- title: z.string().default(""),
44
+ title: text,
30
45
  // A thread link that is not a GitHub URL is dropped and the finding kept.
31
- url: z.string().regex(THREAD_URL).optional().catch(undefined), // the finding's inline thread, linked from the summary
32
- verified: z.string().default(""), // what the verifier checked, quoted code included
46
+ url: absent(z.string().regex(THREAD_URL)).catch(undefined), // the finding's inline thread, linked from the summary
47
+ // What the verifier checked, quoted code included. A bare `true` carries no evidence, so it reads as unverified.
48
+ verified: z.union([z.string(), z.boolean().transform(() => "")]).nullish().transform((v) => v ?? ""),
33
49
  // The claim made checkable: an input, what the code should do on it, and what it does.
34
- evidence: z.object({ input: z.string().min(1), expected: z.string().min(1), actual: z.string().min(1) }).optional(),
35
- suggestion: z.string().optional(), // replacement for exactly the lines the comment covers: GitHub's one-click commit
36
- inline: z.boolean().default(true), // false when the finding has no line in the diff to anchor on
50
+ evidence: absent(z.object({ input: z.string().min(1), expected: z.string().min(1), actual: z.string().min(1) })),
51
+ suggestion: absent(z.string()), // replacement for exactly the lines the comment covers: GitHub's one-click commit
52
+ inline: flag(true), // false when the finding has no line in the diff to anchor on
37
53
  // The read-only commands the reviewer or verifier ran to check it.
38
- checked: z.array(z.object({ command: z.string(), result: z.string() })).default([]),
39
- docs: z.array(z.object({ url: z.string().regex(/^https:\/\/[^\s()<>`]+$/), title: z.string() })).default([]), // the documentation the claim rests on
40
- reintroduces: z.string().regex(THREAD_URL).optional().catch(undefined), // a resolved thread whose fix this change undoes
54
+ checked: z.array(z.object({ command: z.string(), result: z.string() })).nullish().transform((v) => v ?? []),
55
+ docs: z.array(z.object({ url: z.string().regex(/^https:\/\/[^\s()<>`]+$/), title: z.string() })).nullish().transform((v) => v ?? []), // the documentation the claim rests on
56
+ reintroduces: absent(z.string().regex(THREAD_URL)).catch(undefined), // a resolved thread whose fix this change undoes
41
57
  });
42
58
 
43
59
  export const SummaryInput = z.object({
44
60
  head_sha: z.string().regex(/^[0-9a-f]{7,40}$/),
45
- verdict: z.enum(["blocked", "changes", "nits", "good"]),
46
- why: z.string(),
47
- confidence: z.number().int().min(0).max(5).optional(), // how safe to merge, 5 safest
61
+ verdict: z.string().transform(VERDICT_ALIAS).pipe(z.enum(["blocked", "changes", "nits", "good"])),
62
+ why: text,
63
+ confidence: absent(z.number().int().min(0).max(5)), // how safe to merge, 5 safest
48
64
  findings: z.array(Finding).default([]),
49
65
  walkthrough: z.array(z.string()).default([]), // what the PR does, a few bullets for a reader who never saw it
50
66
  changes: z.array(z.object({ files: z.array(z.string()).min(1), summary: z.string() })).default([]),
51
- effort: z.number().int().min(1).max(5).optional(), // review effort, 1 trivial to 5 a long careful read
52
- diagram: z.string().default(""), // mermaid flowchart source, when the change has a flow worth drawing
67
+ effort: absent(z.number().int().min(1).max(5)), // review effort, 1 trivial to 5 a long careful read
68
+ diagram: text, // mermaid flowchart source, when the change has a flow worth drawing
53
69
  // Pre-merge checks: do the title, description, linked issue and scope match the diff.
54
70
  pre_merge: z.array(z.object({ check: z.string(), status: z.enum(["pass", "warn", "fail"]), detail: z.string() })).default([]),
55
71
  still_open: z.array(z.object({ url: z.string().regex(THREAD_URL).catch(""), title: z.string() })).default([]), // "" renders the title alone
56
72
  checks: z.array(z.object({ tool: z.string(), status: z.enum(["ran", "unavailable"]), findings: z.number().default(0), reason: z.string().optional() })).default([]),
57
- lenses: z.array(z.object({ lens: z.string(), model: z.string().default(""), scope: z.union([z.string(), z.array(z.string())]).default("full"), status: z.enum(["ok", "failed", "could_not_run"]), take: z.string().default(""), skill_blob: z.string().default("") })).default([]),
73
+ lenses: z
74
+ .array(
75
+ z
76
+ .object({ lens: z.string(), model: z.string().default(""), scope: z.union([z.string(), z.array(z.string())]).default("full"), status: z.string().transform(STATUS_ALIAS).pipe(z.enum(["ok", "failed", "could_not_run"])), take: z.string().default(""), reason: z.string().default(""), skill_blob: z.string().default("") })
77
+ // A lens skipped "with a reason", as the local record writes it, keeps the reason as its take.
78
+ .transform(({ reason, ...l }) => ({ ...l, take: l.take || reason })),
79
+ )
80
+ .default([]),
58
81
  lenses_yml_blob: z.string().default(""),
59
82
  });
60
83
 
@@ -341,11 +341,21 @@ jobs:
341
341
  mkdir -p "$SHEPHERD_HANDOFF" && cp "$SHEPHERD_FANOUT" "$SHEPHERD_HANDOFF/fanout.json"
342
342
  opencode run --auto -m "$model" --title "shepherd #$PR" "Load the shepherd skill and run exactly one iteration on PR $PR in handoff mode:
343
343
  SHEPHERD_HANDOFF is set, so follow the skill's Handoff mode. Swarm's first wave is in $SHEPHERD_FANOUT: dispatch
344
- the router and every lens listed there in one message. Write the round to $SHEPHERD_HANDOFF/round.json: the publish
345
- job renders and posts the inline review and the summary from it, so post neither yourself. You are running in GitHub Actions on the PR branch,
344
+ the router and every lens listed there in one message. Write the round to $SHEPHERD_HANDOFF/round.json and check it
345
+ with 'shepherd summary $SHEPHERD_HANDOFF/round.json --body > /dev/null', fixing every error it prints on stderr (never
346
+ redirect stderr): the publish job renders and posts the inline review and the summary from it, so post neither
347
+ yourself. You are running in GitHub Actions on the PR branch,
346
348
  already checked out, and you cannot push. Nobody is watching this session: never wait for an answer. Anything you
347
349
  would ask the user is deferred, listed in the iteration summary, and named in status.json. Do not schedule further
348
350
  iterations; the next one starts when CI or stamp finishes on the head the workflow pushes."
351
+ # The job checks the round itself. A round that does not render gets one short call with the exact errors.
352
+ round="$SHEPHERD_HANDOFF/round.json"
353
+ if [ -f "$round" ] && ! errors=$(shepherd summary "$round" --body 2>&1 >/dev/null); then
354
+ echo "::warning::round.json does not render; asking the model to fix it"
355
+ opencode run --auto -m "$model" --title "shepherd #$PR round.json" "The round you wrote to $round does not
356
+ render. Fix exactly these errors in that file and change nothing else, then run 'shepherd summary $round --body > /dev/null'
357
+ and repeat until it prints nothing on stderr. Errors: ${errors:0:6000}" || true
358
+ fi
349
359
  - name: Bundle the commits
350
360
  env:
351
361
  H0: ${{ needs.gate.outputs.head }}