@sweny-ai/core 0.1.131 → 0.1.133

package/dist/cli/comment-output.d.ts

@@ -0,0 +1,29 @@
+/**
+ * PR billboard: the markdown a CI runner posts as one sticky comment on a
+ * pull request. Pure and runner-agnostic; the CLI writes it with
+ * `--comment-file`, and any runner (the GitHub Action, GitLab, a script) posts it.
+ *
+ * METADATA ONLY. Node names, statuses, counts, and durations. Never prompts,
+ * tool inputs, node outputs, errors, or model prose.
+ */
+import type { ExecutionTrace, NodeResult, Workflow } from "../types.js";
+import { type RunSummary } from "./run-output.js";
+export declare const RUN_COMMENT_FOOTER = "Run with [SWEny](https://sweny.ai): `npx @sweny-ai/core new`";
+export interface RunCommentOptions {
+    trace?: ExecutionTrace;
+    /** Per-node wall-clock duration in ms, keyed by node id. Missing entries render as "-". */
+    durationsMs?: Record<string, number>;
+}
+/** Hidden marker the poster searches for to update the comment in place. */
+export declare function runCommentMarker(workflowId: string): string;
+export declare function formatRunComment(workflow: Workflow, results: Map<string, NodeResult>, summary: RunSummary, opts?: RunCommentOptions): string;
+/**
+ * Minimal comment for a run that crashed before producing node results: no DAG
+ * and no error text (thrown messages can embed model prose). Replaces any stale
+ * success comment for the same workflow.
+ */
+export declare function formatCrashComment(workflow: Workflow, summary: RunSummary): string;
+/** Write the comment markdown to `file`. Never throws; returns true only when written. */
+export declare function writeRunComment(file: string, workflow: Workflow, results: Map<string, NodeResult>, summary: RunSummary, opts?: RunCommentOptions & {
+    crashed?: boolean;
+}): boolean;

package/dist/cli/comment-output.js

@@ -0,0 +1,82 @@
+/**
+ * PR billboard: the markdown a CI runner posts as one sticky comment on a
+ * pull request. Pure and runner-agnostic; the CLI writes it with
+ * `--comment-file`, and any runner (the GitHub Action, GitLab, a script) posts it.
+ *
+ * METADATA ONLY. Node names, statuses, counts, and durations. Never prompts,
+ * tool inputs, node outputs, errors, or model prose.
+ */
+import fs from "node:fs";
+import path from "node:path";
+import { toMermaidBlock } from "../mermaid.js";
+import { STEP_SUMMARY_CLASS_DEFS, formatReceipt, formatReceiptDuration, nodeStates, } from "./run-output.js";
+export const RUN_COMMENT_FOOTER = "Run with [SWEny](https://sweny.ai): `npx @sweny-ai/core new`";
+/** Hidden marker the poster searches for to update the comment in place. */
+export function runCommentMarker(workflowId) {
+    const safe = workflowId.replace(/[^A-Za-z0-9._-]+/g, "_").replace(/-{2,}/g, "-") || "workflow";
+    return `<!-- sweny-run-comment:${safe} -->`;
+}
+/** Table-cell-safe text: no pipes, newlines, or backticks. */
+function cell(text) {
+    return text.replace(/\s+/g, " ").replace(/\|/g, "\\|").replace(/`/g, "'").trim();
+}
+const STATUS_LABEL = { success: "✅ success", failed: "❌ failed", skipped: "⏭️ skipped" };
+export function formatRunComment(workflow, results, summary, opts = {}) {
+    const state = nodeStates(results);
+    const rows = [...results].map(([id, r]) => {
+        const name = cell(workflow.nodes[id]?.name ?? id);
+        const ms = opts.durationsMs?.[id];
+        const dur = typeof ms === "number" && Number.isFinite(ms) ? formatReceiptDuration(ms) : "-";
+        return `| ${name} | ${STATUS_LABEL[r.status]} | ${dur} |`;
+    });
+    return [
+        runCommentMarker(workflow.id),
+        `## ${summary.ok ? "✅" : "❌"} ${cell(workflow.name)}`,
+        "",
+        `\`${formatReceipt(summary)}\``,
+        "",
+        toMermaidBlock(workflow, { state, trace: opts.trace, classDefs: STEP_SUMMARY_CLASS_DEFS }),
+        "",
+        "<details>",
+        "<summary>Nodes</summary>",
+        "",
+        "| Node | Status | Duration |",
+        "| --- | --- | --- |",
+        ...rows,
+        "",
+        "</details>",
+        "",
+        `<sub>${RUN_COMMENT_FOOTER}</sub>`,
+        "",
+    ].join("\n");
+}
+/**
+ * Minimal comment for a run that crashed before producing node results: no DAG
+ * and no error text (thrown messages can embed model prose). Replaces any stale
+ * success comment for the same workflow.
+ */
+export function formatCrashComment(workflow, summary) {
+    return [
+        runCommentMarker(workflow.id),
+        `## ❌ ${cell(workflow.name)}`,
+        "",
+        `\`${formatReceipt(summary)} · crashed\``,
+        "",
+        "The run stopped before finishing. See the job log for details.",
+        "",
+        `<sub>${RUN_COMMENT_FOOTER}</sub>`,
+        "",
+    ].join("\n");
+}
+/** Write the comment markdown to `file`. Never throws; returns true only when written. */
+export function writeRunComment(file, workflow, results, summary, opts = {}) {
+    try {
+        fs.mkdirSync(path.dirname(file), { recursive: true });
+        fs.writeFileSync(file, opts.crashed ? formatCrashComment(workflow, summary) : formatRunComment(workflow, results, summary, opts));
+        return true;
+    }
+    catch (err) {
+        process.stderr.write(`  ⚠ could not write comment file: ${err instanceof Error ? err.message : err}\n`);
+        return false;
+    }
+}

package/dist/cli/main.d.ts

@@ -5,6 +5,7 @@ export declare function workflowRunAction(file: string | undefined, options: Rec
     json?: boolean;
     stream?: boolean;
     mermaid?: boolean;
+    commentFile?: string;
     verbose?: boolean;
     timeout?: string;
     maxSteps?: string;

package/dist/cli/main.js

@@ -32,6 +32,7 @@ import { registerRunsCommand } from "./runs.js";
 import { runE2eRun, runWithWallClockBudget, DEFAULT_WORKFLOW_TIMEOUT_MS } from "./e2e.js";
 import { createVerboseToolObserver } from "./verbose-observer.js";
 import { createRunLogger, renderReceiptLine, summarizeRun, writeStepSummary, WORKFLOW_RUN_DESCRIPTION, WORKFLOW_RUN_OPTIONS, } from "./run-output.js";
+import { writeRunComment } from "./comment-output.js";
 import { registerTriageCommand, registerImplementCommand, parseCliInputs, validateInputs, validateWarnings, parsePositiveInt, } from "./config.js";
 import { c, formatBanner, getStepDetails, formatStepLine, formatDagResultHuman, formatDagResultMarkdown, formatResultJson, formatValidationErrors, formatCrashError, formatCheckResults, } from "./output.js";
 import { checkProviderConnectivity, detectClaudeCodeLogin, discoverWorkflowSkillIds, validateCheckInputs, } from "./check.js";
@@ -948,6 +949,14 @@ export async function workflowRunAction(file, options) {
         catch {
             // silent
         }
+        // PR billboard markdown (metadata only). Written before any early exit so
+        // --json runs and failed runs still get a comment.
+        if (options.commentFile) {
+            writeRunComment(options.commentFile, workflow, results, summarizeRun(results, wfDurationMs), {
+                trace,
+                durationsMs: Object.fromEntries(nodeTimer.durations),
+            });
+        }
         if (isJson) {
             process.stdout.write(JSON.stringify(Object.fromEntries(results), null, 2) + "\n");
             process.exit(wfHasFailed ? 1 : 0);
@@ -986,6 +995,12 @@ export async function workflowRunAction(file, options) {
         runLogger.flush();
         recordHistory(nodeTimer.lastResults, undefined, true);
         console.error(`  ${renderReceiptLine(summarizeRun(new Map(), Date.now() - runStart, true), isTTY)}\n`);
+        // A crash must not leave a stale success comment behind.
+        if (options.commentFile) {
+            writeRunComment(options.commentFile, workflow, new Map(), summarizeRun(new Map(), Date.now() - runStart, true), {
+                crashed: true,
+            });
+        }
         // Finalize the cloud run as failed (covers thrown errors, incl.
         // RouteEvaluationError). Without this a crashed workflow run stays
         // "running" in cloud forever.

package/dist/cli/run-output.d.ts

@@ -6,6 +6,7 @@
  * model prose: only counts, durations, token totals, and cost.
  */
 import { type ExecutionTrace, type Logger, type NodeResult, type Workflow } from "../types.js";
+import { type NodeStatus } from "../mermaid.js";
 export interface RunSummary {
     ok: boolean;
     nodesOk: number;
@@ -31,6 +32,12 @@ export declare function formatCost(usd: number): string;
 export declare function formatReceipt(s: RunSummary): string;
 /** Receipt for a terminal: colored only when `color` is true. */
 export declare function renderReceiptLine(s: RunSummary, color: boolean): string;
+/** Brand blue (blue-600 / blue-700), not indigo. Applied to successful nodes. */
+export declare const STEP_SUMMARY_CLASS_DEFS: {
+    readonly success: "fill:#2563eb,stroke:#1d4ed8,color:#fff,stroke-width:2px";
+};
+/** Per-node Mermaid status from run results. */
+export declare function nodeStates(results: Map<string, NodeResult>): Record<string, NodeStatus>;
 /** Markdown for `$GITHUB_STEP_SUMMARY`: receipt + status-colored Mermaid DAG. */
 export declare function formatStepSummary(workflow: Workflow, results: Map<string, NodeResult>, summary: RunSummary, trace?: ExecutionTrace): string;
 /**

package/dist/cli/run-output.js

@@ -94,15 +94,20 @@ export function renderReceiptLine(s, color) {
 }
 // ── Step summary ────────────────────────────────────────────────
 /** Brand blue (blue-600 / blue-700), not indigo. Applied to successful nodes. */
-const STEP_SUMMARY_CLASS_DEFS = {
+export const STEP_SUMMARY_CLASS_DEFS = {
     success: "fill:#2563eb,stroke:#1d4ed8,color:#fff,stroke-width:2px",
 };
-/** Markdown for `$GITHUB_STEP_SUMMARY`: receipt + status-colored Mermaid DAG. */
-export function formatStepSummary(workflow, results, summary, trace) {
+/** Per-node Mermaid status from run results. */
+export function nodeStates(results) {
     const state = {};
     for (const [id, r] of results) {
         state[id] = r.status === "success" ? "success" : r.status === "failed" ? "failed" : "skipped";
     }
+    return state;
+}
+/** Markdown for `$GITHUB_STEP_SUMMARY`: receipt + status-colored Mermaid DAG. */
+export function formatStepSummary(workflow, results, summary, trace) {
+    const state = nodeStates(results);
     return [
         `## ${summary.ok ? "✅" : "❌"} ${workflow.name}`,
         "",
@@ -185,5 +190,9 @@ export const WORKFLOW_RUN_OPTIONS = [
         "Show raw log lines and each tool call's input and output inline (human-readable, truncated). Use --stream for full untruncated NDJSON.",
     ],
     ["--mermaid", "Output a Mermaid diagram with execution state after run"],
+    [
+        "--comment-file <path>",
+        "Write a PR-comment markdown (run receipt, status-colored DAG, per-node table; metadata only) to <path> so any CI can post it",
+    ],
     ["--input <json>", "JSON string of input data to pass to the workflow"],
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sweny-ai/core",
-  "version": "0.1.131",
+  "version": "0.1.133",
   "type": "module",
   "bin": {
     "sweny": "./dist/cli/main.js"
@@ -69,7 +69,7 @@
     "ajv": "^8.20.0",
     "esbuild": "^0.28.1",
     "prettier": "^3.9.6",
-    "vitest": "^4.1.10"
+    "vitest": "^4.1.11"
   },
   "publishConfig": {
     "access": "public"