@diffci.com/diffci 0.1.5 → 0.1.6

package/README.md

@@ -14,6 +14,21 @@ From an existing repository checkout, with Node.js 22.5+ and Git installed:
 npx @diffci.com/diffci@latest observe --no-send
 ```
 
+For the fastest self-serve runtime pilot, run one paired check from the repository root:
+
+```bash
+npx @diffci.com/diffci@latest pilot --full "npm test"
+```
+
+On Windows PowerShell, quote the package name:
+
+```powershell
+npx '@diffci.com/diffci@latest' pilot --full "npm test"
+```
+
+This writes `diffci-observe.json`, `diffci-savings.json`, and `diffci-savings.md` to a sibling
+`diffci-output` folder outside the checkout, so it does not dirty the repository.
+
 **Upgrade from 0.1.3:** tests excluded by a source-only `tsconfig.json` could be discovered without
 their dependency edges, producing an incomplete selection. This is fixed in **0.1.4**. Revalidate
 affected observations before using them as opportunity evidence; see the
@@ -34,8 +49,8 @@ not Cal.com's production savings or a prediction for your repository.
 Selection counts alone do not establish runtime savings. Observation mode measures neither the
 selected test execution nor realized savings.
 
-For a self-serve paired runtime check, run `observe` first and then run `verify-savings` against the
-observation report. It compares your normal full command with
+For an advanced paired runtime check, you can still run `observe` first and then run `verify-savings`
+against the observation report. It compares your normal full command with
 DiffCI's proposed selected command and writes JSON plus Markdown evidence; see
 [`docs/npm-adoption.md`](docs/npm-adoption.md#self-serve-runtime-pilot).
 

package/dist-client/src/client/cli.js

@@ -28,7 +28,7 @@
 import { execFileSync } from "node:child_process";
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { tmpdir } from "node:os";
-import { dirname, join, resolve } from "node:path";
+import { basename, dirname, join, resolve } from "node:path";
 import { observe, isInsideRepository } from "./observe.js";
 import { submitObservation } from "./submit.js";
 import { formatVerifySavingsSummary, runVerifySavings, writeVerifySavingsReport } from "./verify-savings.js";
@@ -286,9 +286,65 @@ function runVerifySavingsCommand(flags, env) {
         console.log(`  markdown: ${options.markdown}`);
     return report.comparison.fullCommandSucceeded && report.comparison.selectedCommandSucceeded ? 0 : 1;
 }
+function defaultPilotOutputDir(repoPath) {
+    return join(dirname(repoPath), "diffci-output");
+}
+async function runPilot(flags, env) {
+    const full = stringFlag(flags, "full");
+    if (!full) {
+        console.error('--full <command> is required, for example: diffci pilot --full "npm test"');
+        return 1;
+    }
+    const repoPath = resolve(stringFlag(flags, "repo") ?? env.GITHUB_WORKSPACE ?? process.cwd());
+    const outDir = resolve(stringFlag(flags, "out-dir") ?? defaultPilotOutputDir(repoPath));
+    if (isInsideRepository(repoPath, outDir) || outDir === repoPath) {
+        console.error(`Refusing to write pilot reports inside the repository: ${outDir}. Pass --out-dir with a path outside the checkout.`);
+        return 2;
+    }
+    const label = stringFlag(flags, "label") ?? basename(repoPath);
+    const observationPath = join(outDir, "diffci-observe.json");
+    const savingsPath = join(outDir, "diffci-savings.json");
+    const markdownPath = join(outDir, "diffci-savings.md");
+    const identity = observerIdentity();
+    const observation = await observe({
+        repoPath,
+        env: env,
+        version: identity.version,
+        engineSha: identity.sha,
+        baseOverride: stringFlag(flags, "base"),
+        headOverride: stringFlag(flags, "head"),
+        redactPaths: flags["redact-paths"] === true,
+        reportPath: observationPath,
+    });
+    mkdirSync(outDir, { recursive: true });
+    writeFileSync(observationPath, `${JSON.stringify(observation, null, 2)}\n`, "utf8");
+    console.log(summarise(observation));
+    console.log(`  observation report: ${observationPath}`);
+    if (observation.status !== "OBSERVED") {
+        console.log("DiffCI pilot stopped before timing because observation did not produce a selectable report.");
+        return 1;
+    }
+    const savings = runVerifySavings({
+        full,
+        selectedFromReport: observationPath,
+        out: savingsPath,
+        markdown: markdownPath,
+        label,
+        cwd: repoPath,
+        timeoutMs: numberFlag(flags, "timeout-ms") ?? 30 * 60 * 1000,
+        analysisOverheadMs: numberFlag(flags, "analysis-overhead-ms"),
+        tailBytes: numberFlag(flags, "tail-bytes") ?? 12_000,
+    });
+    writeVerifySavingsReport(savings, { out: savingsPath, markdown: markdownPath });
+    console.log(formatVerifySavingsSummary(savings));
+    console.log(`  savings report: ${savingsPath}`);
+    console.log(`  markdown: ${markdownPath}`);
+    return savings.comparison.fullCommandSucceeded && savings.comparison.selectedCommandSucceeded ? 0 : 1;
+}
 const USAGE = `diffci - observation-only change-aware CI analysis
 
 Usage:
+  diffci pilot --full <command> [--repo <path>] [--out-dir <dir>] [--label <name>]
   diffci observe [--repo <path>] [--out <file>] [--base <sha> --head <sha>]
                  [--redact-paths] [--json] [--quiet] [--fail-on-error]
                  [--api-url <url> --api-token <token>] [--no-send]
@@ -298,6 +354,7 @@ Usage:
   diffci verify-workflow [--repo <path>]
   diffci version
 
+pilot runs observe and verify-savings together, writing reports to ../diffci-output by default.
 observe analyses the checkout and writes one JSON report. It runs nothing and changes nothing.
 verify-savings runs both commands and reports measured paired runtime; it is an opt-in pilot command.
 verify-workflow checks that the job running DiffCI cannot affect any other job, and exits 1 if it can.
@@ -315,6 +372,9 @@ async function main() {
         return;
     }
     switch (command) {
+        case "pilot":
+            process.exitCode = await runPilot(flags, env);
+            return;
         case "observe":
             process.exitCode = await runObserve(flags, env);
             return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diffci.com/diffci",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "DiffCI - deterministic change-aware CI planning",
   "license": "AGPL-3.0-only",
   "repository": {