bulletin-deploy 0.6.7 → 0.6.8-rc.0

package/README.md

@@ -135,6 +135,7 @@ If you see **"Requires Full Personhood verification"**, the deploy will fail ear
 |---|---|---|
 | `BULLETIN_RPC` | `wss://paseo-bulletin-rpc.polkadot.io` | Bulletin chain WebSocket RPC |
 | `BULLETIN_DEPLOY_TELEMETRY` | `1` (enabled) | Set to `0` to disable Sentry telemetry |
+| `BULLETIN_DEPLOY_UPDATE_CHECK` | `1` (enabled) | Set to `0` to disable version check on errors |
 | `DOTNS_STATUS` | `full` (testnet) / `none` (mainnet) | PoP level to self-grant before registration: `none`, `lite`, or `full` |
 | `IPFS_CID` | _(none)_ | Skip storage, use pre-existing CID |
 
@@ -202,6 +203,22 @@ Instead of using a single account for all storage transactions, bulletin-deploy
 
 When a pool account's authorization drops below thresholds (50 transactions or 50MB), bulletin-deploy automatically tops it up by submitting an `authorize_account` transaction from Alice.
 
+## Version Checking
+
+When a deploy fails, bulletin-deploy checks whether a newer version is available. This helps catch cases where the error was already fixed in a later release.
+
+Two sources are checked in parallel:
+- **npm registry** — reads the `minimumVersion` field from the latest published version
+- **GitHub kill switch** (`min-version.json` in the repo) — allows emergency deprecation without a release
+
+If either source indicates your version is below the minimum, the CLI tells you the version is unsupported and why. If you're simply outdated (but above the minimum), you get a suggestion to update.
+
+For **paritytech** contributors in an interactive terminal, the CLI offers to update and retry automatically. For everyone else (external users, CI), it prints the update command and exits.
+
+If you're already on the latest version and hit an error, the CLI offers to open a GitHub issue with collected debug info (paritytech contributors only).
+
+Set `BULLETIN_DEPLOY_UPDATE_CHECK=0` to disable version checking.
+
 ## Telemetry
 
 Sentry telemetry is enabled by default for deploy observability. Set `BULLETIN_DEPLOY_TELEMETRY=0` to disable.
@@ -212,10 +229,11 @@ What's tracked:
 - DotNS phase timing (registration, contenthash update)
 - Pool account selection
 - Source metadata (repo, branch, PR number, CI vs local)
+- Tool version (`deploy.tool_version`)
 
 Dashboard:
-- Bulletin Deploy Health: https://paritytech.sentry.io/dashboard/1669817/
-- Deploy Failures Detail: https://paritytech.sentry.io/dashboard/1669818/
+- Bulletin Deploy Health: https://paritytech.sentry.io/dashboard/1669817/?project=4511093597405264
+- Deploy Failures Detail: https://paritytech.sentry.io/dashboard/1669818/?project=4511093597405264
 
 ## Troubleshooting
 

package/bin/bulletin-deploy

@@ -3,6 +3,8 @@
 import { deploy, DEFAULT_BULLETIN_RPC, DEFAULT_POOL_SIZE, NonRetryableError, EXIT_CODE_NO_RETRY } from "../dist/deploy.js";
 import { bootstrapPool } from "../dist/pool.js";
 import { VERSION } from "../dist/telemetry.js";
+import { handleFailedDeploy } from "../dist/version-check.js";
+import { setDeployContext } from "../dist/bug-report.js";
 import * as fs from "fs";
 
 const args = process.argv.slice(2);
@@ -57,6 +59,14 @@ try {
     if (!domain) { console.error("Error: domain required (e.g. my-app.dot)"); process.exit(1); }
     if (!fs.existsSync(buildDir)) { console.error(`Error: ${buildDir} does not exist`); process.exit(1); }
 
+    setDeployContext({
+      domain,
+      rpc: flags.rpc,
+      repo: process.env.GITHUB_REPOSITORY,
+      branch: process.env.GITHUB_HEAD_REF || process.env.GITHUB_REF_NAME,
+      signerMode: flags.mnemonic ? "direct" : "pool",
+    });
+
     const result = await deploy(buildDir, domain, {
       playground: flags.playground,
       mnemonic: flags.mnemonic,
@@ -79,5 +89,6 @@ try {
 } catch (error) {
   const noRetry = error instanceof NonRetryableError;
   console.error(`Deployment failed${noRetry ? " (not retryable)" : ""}:`, error.message);
+  await handleFailedDeploy(error);
   process.exit(noRetry ? EXIT_CODE_NO_RETRY : 1);
 }

package/dist/bug-report.d.ts

@@ -0,0 +1,14 @@
+interface DeployContext {
+    domain?: string;
+    repo?: string;
+    branch?: string;
+    signerMode?: string;
+    chunkCount?: number;
+    totalSize?: string;
+    rpc?: string;
+    sentryTraceId?: string;
+}
+declare function setDeployContext(ctx: Partial<DeployContext>): void;
+declare function offerBugReport(error: Error): Promise<void>;
+
+export { offerBugReport, setDeployContext };

package/dist/bug-report.js

@@ -0,0 +1,108 @@
+import {
+  classifyErrorArea,
+  isInteractive,
+  promptYesNo
+} from "./chunk-GCAPBR6G.js";
+import {
+  VERSION
+} from "./chunk-GJVD4HRJ.js";
+import "./chunk-QGM4M3NI.js";
+
+// src/bug-report.ts
+import { execSync, execFileSync } from "child_process";
+import * as os from "os";
+var _deployContext = {};
+function setDeployContext(ctx) {
+  _deployContext = { ..._deployContext, ...ctx };
+}
+function hasGhCli() {
+  try {
+    execSync("gh --version", { stdio: "pipe" });
+    return true;
+  } catch {
+    return false;
+  }
+}
+function buildReportBody(error) {
+  const lines = [
+    "## Environment",
+    "",
+    `- **bulletin-deploy**: ${VERSION}`,
+    `- **Node.js**: ${process.version}`,
+    `- **OS**: ${os.platform()} ${os.arch()} ${os.release()}`,
+    "",
+    "## Error",
+    "",
+    "```",
+    error.stack || error.message,
+    "```",
+    ""
+  ];
+  const ctx = _deployContext;
+  if (ctx.domain || ctx.repo || ctx.rpc) {
+    lines.push("## Deploy Context", "");
+    if (ctx.domain) lines.push(`- **Domain**: ${ctx.domain}`);
+    if (ctx.repo) lines.push(`- **Repo**: ${ctx.repo}`);
+    if (ctx.branch) lines.push(`- **Branch**: ${ctx.branch}`);
+    if (ctx.signerMode) lines.push(`- **Signer mode**: ${ctx.signerMode}`);
+    if (ctx.chunkCount != null) lines.push(`- **Chunks**: ${ctx.chunkCount}`);
+    if (ctx.totalSize) lines.push(`- **Total size**: ${ctx.totalSize}`);
+    if (ctx.rpc) lines.push(`- **RPC**: ${ctx.rpc}`);
+    if (ctx.sentryTraceId) lines.push(`- **Sentry trace**: ${ctx.sentryTraceId}`);
+    lines.push("");
+  }
+  return lines.join("\n");
+}
+function buildTitle(error) {
+  const msg = error.message.slice(0, 60);
+  return `[deploy-bug] ${msg}`;
+}
+function buildLabels(error) {
+  const labels = ["bug", "auto-report"];
+  const area = classifyErrorArea(error.message);
+  if (area) labels.push(area);
+  return labels;
+}
+async function offerBugReport(error) {
+  if (!isInteractive()) return;
+  const yes = await promptYesNo("\n   This looks like a bug. Open an issue with debug info? [Y/n] ");
+  if (!yes) return;
+  const title = buildTitle(error);
+  const body = buildReportBody(error);
+  const labels = buildLabels(error);
+  if (hasGhCli()) {
+    try {
+      const args = [
+        "issue",
+        "create",
+        "--repo",
+        "paritytech/bulletin-deploy",
+        "--title",
+        title,
+        ...labels.flatMap((l) => ["--label", l]),
+        "--body-file",
+        "-"
+      ];
+      execFileSync("gh", args, { input: body, stdio: ["pipe", "inherit", "inherit"] });
+      console.error("   Issue created.");
+    } catch {
+      console.error("   Failed to create issue. Debug info below:\n");
+      printFallback(title, body, labels);
+    }
+  } else {
+    console.error("\n   gh CLI not found. Debug info below \u2014 paste into a new issue:\n");
+    console.error(`   https://github.com/paritytech/bulletin-deploy/issues/new
+`);
+    printFallback(title, body, labels);
+  }
+}
+function printFallback(title, body, labels) {
+  console.error(`   Title: ${title}`);
+  console.error(`   Labels: ${labels.join(", ")}
+`);
+  console.error(body);
+}
+export {
+  offerBugReport,
+  setDeployContext
+};

package/dist/{chunk-TD73EZ5I.js → chunk-AUTRMT26.js}

@@ -4,7 +4,7 @@ import {
   TX_TIMEOUT_MS,
   fetchNonce,
   validateDomainLabel
-} from "./chunk-FBXG7YMT.js";
+} from "./chunk-FI2IKRB7.js";
 import {
   merkleizeJS
 } from "./chunk-GZ5UUECB.js";
@@ -21,7 +21,7 @@ import {
   setDeployAttribute,
   withDeploySpan,
   withSpan
-} from "./chunk-ZGP4DMFK.js";
+} from "./chunk-GJVD4HRJ.js";
 
 // src/deploy.ts
 import { Buffer } from "buffer";

package/dist/{chunk-FBXG7YMT.js → chunk-FI2IKRB7.js}

@@ -1,7 +1,7 @@
 import {
   captureWarning,
   withSpan
-} from "./chunk-ZGP4DMFK.js";
+} from "./chunk-GJVD4HRJ.js";
 
 // src/dotns.ts
 import crypto from "crypto";

package/dist/chunk-GCAPBR6G.js

@@ -0,0 +1,146 @@
+import {
+  VERSION
+} from "./chunk-GJVD4HRJ.js";
+
+// src/version-check.ts
+import { execSync, execFileSync } from "child_process";
+import { createInterface } from "readline";
+var REGISTRY_URL = "https://registry.npmjs.org/bulletin-deploy/latest";
+var KILL_SWITCH_URL = "https://raw.githubusercontent.com/paritytech/bulletin-deploy/main/min-version.json";
+var FETCH_TIMEOUT = 3e3;
+function compareSemver(a, b) {
+  const pa = a.split(".").map(Number);
+  const pb = b.split(".").map(Number);
+  for (let i = 0; i < 3; i++) {
+    if ((pa[i] || 0) < (pb[i] || 0)) return -1;
+    if ((pa[i] || 0) > (pb[i] || 0)) return 1;
+  }
+  return 0;
+}
+async function fetchJson(url) {
+  try {
+    const controller = new AbortController();
+    const timer = setTimeout(() => controller.abort(), FETCH_TIMEOUT);
+    const res = await fetch(url, { signal: controller.signal });
+    clearTimeout(timer);
+    if (!res.ok) return null;
+    return await res.json();
+  } catch {
+    return null;
+  }
+}
+async function fetchVersionInfo() {
+  const [registry, killSwitch] = await Promise.all([
+    fetchJson(REGISTRY_URL),
+    fetchJson(KILL_SWITCH_URL)
+  ]);
+  if (!registry && !killSwitch) return null;
+  return {
+    latest: registry?.version ?? VERSION,
+    minimumFromRegistry: registry?.minimumVersion ?? null,
+    minimumFromKillSwitch: killSwitch?.minimumVersion ?? null,
+    killSwitchMessage: killSwitch?.message ?? null
+  };
+}
+function isInternalUser() {
+  const repo = process.env.GITHUB_REPOSITORY;
+  if (repo?.startsWith("paritytech/")) return true;
+  try {
+    const remote = execSync("git remote get-url origin", { encoding: "utf-8", stdio: ["pipe", "pipe", "pipe"] }).trim();
+    return remote.includes("paritytech/");
+  } catch {
+    return false;
+  }
+}
+function isInteractive() {
+  return Boolean(process.stdin.isTTY && !process.env.CI);
+}
+async function promptYesNo(question) {
+  const rl = createInterface({ input: process.stdin, output: process.stderr });
+  return new Promise((resolve) => {
+    rl.question(question, (answer) => {
+      rl.close();
+      resolve(!answer || answer.toLowerCase().startsWith("y"));
+    });
+  });
+}
+function updateAndRetry() {
+  console.error("\n   Updating bulletin-deploy...");
+  try {
+    execSync("npm install -g bulletin-deploy@latest", { stdio: "inherit" });
+    console.error("   Updated. Retrying deploy...\n");
+    execFileSync(process.argv[0], process.argv.slice(1), { stdio: "inherit" });
+    process.exit(0);
+  } catch {
+    console.error("   Update failed. Please run: npm install -g bulletin-deploy@latest");
+    process.exit(1);
+  }
+}
+function classifyErrorArea(msg) {
+  if (/personhood|owned by|owner mismatch|reserved for original|domain|dotns|commit-reveal/i.test(msg)) return "area:dotns";
+  if (/chunk|storage|authorized|authorization|pool|alice/i.test(msg)) return "area:storage";
+  if (/ipfs|cid|pin|dag/i.test(msg)) return "area:ipfs";
+  if (/connect|timeout|websocket|rpc|ECONNREFUSED|ENOTFOUND/i.test(msg)) return "area:network";
+  return null;
+}
+function assessVersion(currentVersion, info, internal) {
+  const effectiveMinimum = [info.minimumFromRegistry, info.minimumFromKillSwitch].filter(Boolean).sort((a, b) => compareSemver(b, a))[0] ?? null;
+  if (effectiveMinimum && compareSemver(currentVersion, effectiveMinimum) < 0) {
+    return { action: "forced_update", currentVersion, minimumVersion: effectiveMinimum, message: info.killSwitchMessage };
+  }
+  if (compareSemver(currentVersion, info.latest) < 0) {
+    return { action: "suggest_update", currentVersion, latestVersion: info.latest, internal };
+  }
+  if (internal) {
+    return { action: "bug_report", internal: true };
+  }
+  return { action: "none" };
+}
+async function handleFailedDeploy(error) {
+  if (process.env.BULLETIN_DEPLOY_UPDATE_CHECK === "0") return;
+  const info = await fetchVersionInfo();
+  if (!info) return;
+  let verdict = assessVersion(VERSION, info, false);
+  if (verdict.action === "suggest_update" || verdict.action === "none") {
+    const internal = isInternalUser();
+    if (internal) verdict = assessVersion(VERSION, info, true);
+  }
+  switch (verdict.action) {
+    case "forced_update":
+      console.error(`
+   bulletin-deploy ${verdict.currentVersion} is no longer supported (minimum: ${verdict.minimumVersion}).`);
+      if (verdict.message) console.error(`   Reason: ${verdict.message}`);
+      console.error(`   Please update: npm install -g bulletin-deploy@latest
+`);
+      break;
+    case "suggest_update":
+      if (verdict.internal && isInteractive()) {
+        const yes = await promptYesNo(`
+   bulletin-deploy ${verdict.currentVersion} \u2192 ${verdict.latestVersion} available. Update and retry? [Y/n] `);
+        if (yes) updateAndRetry();
+        else console.error(`   Skipped. Run: npm install -g bulletin-deploy@latest
+`);
+      } else {
+        console.error(`
+   A newer version of bulletin-deploy is available (${verdict.currentVersion} \u2192 ${verdict.latestVersion}).`);
+        console.error(`   Run: npm install -g bulletin-deploy@latest
+`);
+      }
+      break;
+    case "bug_report": {
+      const { offerBugReport } = await import("./bug-report.js");
+      await offerBugReport(error);
+      break;
+    }
+  }
+}
+
+export {
+  compareSemver,
+  isInternalUser,
+  isInteractive,
+  promptYesNo,
+  classifyErrorArea,
+  assessVersion,
+  handleFailedDeploy
+};

package/dist/{chunk-ZGP4DMFK.js → chunk-GJVD4HRJ.js}

@@ -6,7 +6,7 @@ import * as path from "path";
 // package.json
 var package_default = {
   name: "bulletin-deploy",
-  version: "0.6.7",
+  version: "0.6.8-rc.0",
   private: false,
   repository: {
     type: "git",
@@ -34,7 +34,7 @@ var package_default = {
     "cdm.json"
   ],
   scripts: {
-    build: "tsup src/index.ts src/deploy.ts src/dotns.ts src/pool.ts src/telemetry.ts src/merkle.ts --format esm --dts --clean --target node22",
+    build: "tsup src/index.ts src/deploy.ts src/dotns.ts src/pool.ts src/telemetry.ts src/merkle.ts src/version-check.ts src/bug-report.ts --format esm --dts --clean --target node22",
     test: "npm run build && node --test test/test.js",
     benchmark: "npm run build && node benchmark.js"
   },
@@ -61,6 +61,7 @@ var package_default = {
     tsup: "^8.5.0",
     typescript: "^5.9.3"
   },
+  minimumVersion: "0.5.6",
   engines: {
     node: ">=22"
   }
@@ -81,6 +82,7 @@ function initTelemetry() {
   if (!Sentry) return;
   Sentry.init({
     dsn: process.env.SENTRY_DSN || DEFAULT_DSN,
+    release: `${package_default.name}@${VERSION}`,
     tracesSampleRate: 1,
     environment: process.env.CI ? "ci" : "local"
   });
@@ -119,7 +121,8 @@ function getDeployAttributes(domain) {
     "deploy.repo": resolveRepo(domain),
     "deploy.branch": process.env.GITHUB_HEAD_REF || process.env.GITHUB_REF_NAME || tryGitBranch(),
     "deploy.source": process.env.CI ? "ci" : "local",
-    "deploy.pr": process.env.GITHUB_PR_NUMBER || void 0
+    "deploy.pr": process.env.GITHUB_PR_NUMBER || void 0,
+    "deploy.tool_version": VERSION
   };
 }
 function isExpectedError(msg) {
@@ -154,6 +157,7 @@ async function withDeploySpan(domain, fn) {
         const msg = error.message;
         span.setAttribute("deploy.status", "error");
         span.setAttribute("deploy.error", msg.slice(0, 200));
+        span.setAttribute("deploy.sad", true);
         const isExpected = isExpectedError(msg);
         if (!isExpected) {
           span.setStatus({ code: 2, message: "internal_error" });

package/dist/deploy.js

@@ -21,11 +21,11 @@ import {
   storeChunkedContent,
   storeDirectory,
   storeFile
-} from "./chunk-TD73EZ5I.js";
-import "./chunk-FBXG7YMT.js";
+} from "./chunk-AUTRMT26.js";
+import "./chunk-FI2IKRB7.js";
 import "./chunk-GZ5UUECB.js";
 import "./chunk-LGPTJYA3.js";
-import "./chunk-ZGP4DMFK.js";
+import "./chunk-GJVD4HRJ.js";
 import "./chunk-QGM4M3NI.js";
 export {
   DEFAULT_BULLETIN_RPC,

package/dist/dotns.js

@@ -19,8 +19,8 @@ import {
   sanitizeDomainLabel,
   stripTrailingDigits,
   validateDomainLabel
-} from "./chunk-FBXG7YMT.js";
-import "./chunk-ZGP4DMFK.js";
+} from "./chunk-FI2IKRB7.js";
+import "./chunk-GJVD4HRJ.js";
 import "./chunk-QGM4M3NI.js";
 export {
   CONNECTION_TIMEOUT_MS,

package/dist/index.js

@@ -1,9 +1,9 @@
 import {
   deploy
-} from "./chunk-TD73EZ5I.js";
+} from "./chunk-AUTRMT26.js";
 import {
   DotNS
-} from "./chunk-FBXG7YMT.js";
+} from "./chunk-FI2IKRB7.js";
 import {
   merkleizeJS
 } from "./chunk-GZ5UUECB.js";
@@ -14,7 +14,7 @@ import {
   fetchPoolAuthorizations,
   selectAccount
 } from "./chunk-LGPTJYA3.js";
-import "./chunk-ZGP4DMFK.js";
+import "./chunk-GJVD4HRJ.js";
 import "./chunk-QGM4M3NI.js";
 export {
   DotNS,

package/dist/telemetry.js

@@ -8,7 +8,7 @@ import {
   setDeployAttribute,
   withDeploySpan,
   withSpan
-} from "./chunk-ZGP4DMFK.js";
+} from "./chunk-GJVD4HRJ.js";
 import "./chunk-QGM4M3NI.js";
 export {
   VERSION,

package/dist/version-check.d.ts

@@ -0,0 +1,31 @@
+interface VersionInfo {
+    latest: string;
+    minimumFromRegistry: string | null;
+    minimumFromKillSwitch: string | null;
+    killSwitchMessage: string | null;
+}
+declare function compareSemver(a: string, b: string): number;
+declare function isInternalUser(): boolean;
+declare function isInteractive(): boolean;
+declare function promptYesNo(question: string): Promise<boolean>;
+declare function classifyErrorArea(msg: string): string | null;
+type VersionVerdict = {
+    action: "forced_update";
+    currentVersion: string;
+    minimumVersion: string;
+    message: string | null;
+} | {
+    action: "suggest_update";
+    currentVersion: string;
+    latestVersion: string;
+    internal: boolean;
+} | {
+    action: "bug_report";
+    internal: boolean;
+} | {
+    action: "none";
+};
+declare function assessVersion(currentVersion: string, info: VersionInfo, internal: boolean): VersionVerdict;
+declare function handleFailedDeploy(error: Error): Promise<void>;
+
+export { type VersionVerdict, assessVersion, classifyErrorArea, compareSemver, handleFailedDeploy, isInteractive, isInternalUser, promptYesNo };

package/dist/version-check.js

@@ -0,0 +1,20 @@
+import {
+  assessVersion,
+  classifyErrorArea,
+  compareSemver,
+  handleFailedDeploy,
+  isInteractive,
+  isInternalUser,
+  promptYesNo
+} from "./chunk-GCAPBR6G.js";
+import "./chunk-GJVD4HRJ.js";
+import "./chunk-QGM4M3NI.js";
+export {
+  assessVersion,
+  classifyErrorArea,
+  compareSemver,
+  handleFailedDeploy,
+  isInteractive,
+  isInternalUser,
+  promptYesNo
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bulletin-deploy",
-  "version": "0.6.7",
+  "version": "0.6.8-rc.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
     "cdm.json"
   ],
   "scripts": {
-    "build": "tsup src/index.ts src/deploy.ts src/dotns.ts src/pool.ts src/telemetry.ts src/merkle.ts --format esm --dts --clean --target node22",
+    "build": "tsup src/index.ts src/deploy.ts src/dotns.ts src/pool.ts src/telemetry.ts src/merkle.ts src/version-check.ts src/bug-report.ts --format esm --dts --clean --target node22",
     "test": "npm run build && node --test test/test.js",
     "benchmark": "npm run build && node benchmark.js"
   },
@@ -55,6 +55,7 @@
     "tsup": "^8.5.0",
     "typescript": "^5.9.3"
   },
+  "minimumVersion": "0.5.6",
   "engines": {
     "node": ">=22"
   }