@lchase/kiln 0.11.0 → 0.13.0

package/dist/workflow.js

@@ -1,5 +1,5 @@
 import { createHash } from "node:crypto";
-import { existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
+import { existsSync, mkdirSync, readdirSync, readFileSync, statSync, writeFileSync } from "node:fs";
 import { basename, join, sep } from "node:path";
 import { jobBasename, packageRoot } from "./paths.js";
 const FACTORY_DIRECTIVE = /^<!--\s*factory:\s*(prompts\/factory\/[a-z0-9-]+\.md)\s*-->/;
@@ -12,7 +12,10 @@ const PROMPT_COUNTS = {
     feature: FEATURE_PROMPTS,
     investigation: INVESTIGATION_PROMPTS,
     fix: FIX_PROMPTS,
+    review: 1,
 };
+/** Workflow name for a draft pull-request review. It ends at a gate and does not open a pull request. */
+export const REVIEW_WORKFLOW = "review";
 /**
  * Values Kiln can pass into a workflow. A workflow's inputSchema lists the
  * ones it uses. `description` and `acceptance` stay so
@@ -52,18 +55,7 @@ export function assertWorkflowName(name) {
     }
     return path;
 }
-/**
- * Yak reads `prompt.file` with `path.resolve(cwd, file)`, and Kiln launches
- * yak with cwd set to the product checkout. Rewrite `prompts/kiln/<name>.md`
- * to an absolute file under the kiln directory: the Kiln preamble plus the
- * verbatim factory prompt. The content hash is part of the filename, so a
- * prompt edit changes the path yak caches on.
- *
- * A preamble that starts with `<!-- factory: prompts/factory/<file>.md -->`
- * is combined with that factory body. A prompt without that directive is
- * stored as itself. `prompts/kiln/investigation.md` uses the second form.
- */
-export function materializeWorkflow(kilnDir, jobId, workflowName) {
+export function materializeWorkflow(kilnDir, jobId, workflowName, options = {}) {
     const sourcePath = assertWorkflowName(workflowName);
     const source = readFileSync(sourcePath, "utf8");
     const destDir = join(kilnDir, "rendered", jobBasename(jobId));
@@ -72,7 +64,8 @@ export function materializeWorkflow(kilnDir, jobId, workflowName) {
     const rendered = source.replace(/file: prompts\/kiln\/([a-z0-9-]+)\.md/g, (_full, name) => {
         count += 1;
         const rel = `prompts/kiln/${name}.md`;
-        const absolute = writeCombinedPrompt(rel, destDir);
+        const override = name === "review" ? options.reviewPrompt : undefined;
+        const absolute = writeCombinedPrompt(rel, destDir, override);
         return `file: ${yamlDoubleQuote(absolute)}`;
     });
     const expected = PROMPT_COUNTS[workflowName];
@@ -187,8 +180,18 @@ function declaredInputProperties(yaml) {
     }
     return names;
 }
-function writeCombinedPrompt(preambleRel, destDir) {
+function writeCombinedPrompt(preambleRel, destDir, overridePath) {
     const root = packageRoot();
+    if (overridePath) {
+        if (!existsSync(overridePath) || !statSync(overridePath).isFile()) {
+            throw new Error("Review prompt file was not found.");
+        }
+        const combined = `${readFileSync(overridePath, "utf8").trimEnd()}\n`;
+        const digest = createHash("sha256").update(combined).digest("hex").slice(0, 16);
+        const outPath = join(destDir, `${basename(preambleRel, ".md")}-${digest}.md`);
+        writeFileSync(outPath, combined);
+        return outPath;
+    }
     const preamblePath = join(root, preambleRel);
     const preamble = readFileSync(preamblePath, "utf8");
     const directive = preamble.match(FACTORY_DIRECTIVE);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lchase/kiln",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "description": "Run a workflow on any registered repo. A markdown spec is the input.",
   "license": "MIT",
   "type": "module",

package/prompts/kiln/review.md

@@ -0,0 +1,13 @@
+Kiln runs this review inside yak. The working directory is an isolated worktree at `{{input.baseRef}}`. That commit is the pull request head. Do not guess a branch name.
+
+Read the change. Return a draft review and nothing else. Do not post the review, approve the pull request, merge it, push, or comment. Kiln posts the draft only after a person approves the gate, and only as a comment. Do not change product code. Do not create, modify, or delete files. Read-only git and file inspection are allowed.
+
+Return JSON with `markdown` and `findings`. `findings` is a list. Each item has `severity` (`note`, `nit`, `warning`, or `blocking`), `file`, `line`, and `comment`. `comment` is the text a person might post later. `markdown` is the whole draft a person will read, and it must include every finding with its severity, file, line, and suggested comment. If you find nothing, return an empty `findings` list and say so in `markdown`.
+
+Do not invent files or line numbers. If you did not see a line, do not cite it.
+
+Spec title: {{input.title}}
+
+{{input.spec}}
+
+Launch id: {{input.runNonce}}

package/workflows/review.yaml

@@ -0,0 +1,64 @@
+# Draft review of one pull request, run by yak (@lchase/yak).
+#
+# The agent returns findings (severity, file, line, suggested comment).
+# A person approves or rejects the draft in the Inbox. Approving posts the
+# draft as a pull request comment. Kiln does not approve the pull request
+# or merge it. Rejecting or revising does not post.
+#
+# `reviewPrompt` in the kiln config replaces prompts/kiln/review.md.
+# The packaged file is the generic default.
+#
+# `adapter: "mock"` reads `test/fixtures/kiln-review/draft.json` from the checkout.
+name: kiln-review
+version: "1"
+inputSchema:
+  inline:
+    type: object
+    additionalProperties: false
+    properties:
+      title: { type: string }
+      spec: { type: string }
+      runNonce: { type: string }
+      baseRef: { type: string }
+    required: [title, spec, runNonce, baseRef]
+steps:
+  - id: draft
+    needs: [input]
+    agent:
+      model: opus
+      prompt:
+        file: prompts/kiln/review.md
+      schema:
+        inline:
+          type: object
+          additionalProperties: false
+          properties:
+            markdown: { type: string, minLength: 1 }
+            findings:
+              type: array
+              items:
+                type: object
+                additionalProperties: false
+                properties:
+                  severity: { type: string, enum: [note, nit, warning, blocking] }
+                  file: { type: string, minLength: 1 }
+                  line: { type: integer, minimum: 1 }
+                  comment: { type: string, minLength: 1 }
+                required: [severity, file, line, comment]
+          required: [markdown, findings]
+      tools: [Read, Grep, Glob, Bash]
+    produces: draft
+
+  - id: approve
+    needs: [input, draft]
+    gate:
+      schema:
+        inline:
+          type: object
+          additionalProperties: false
+          properties:
+            decision: { type: string, enum: [approve, reject] }
+          required: [decision]
+      render:
+        inline: "Draft review for \"{{input.title}}\"?\n\nApproving posts this draft as a pull request comment. Kiln does not approve the pull request or merge it.\n\n{{draft.markdown}}"
+    produces: approval