@dbx-tools/projen 0.9.60 → 0.9.61

package/README.md

@@ -481,8 +481,22 @@ bun run release --publish pypi --no-docs
 bun run release --no-npm --no-local-publish
 bun run release --publish local --install never
 bun run release --local-registry false --local-pypi auto
+bun run release --demo-deploy
+bun run release --no-release-notes
 ```
 
+`--demo-deploy` is off by default. After tagging and any local registry
+publication it runs `bun run demo:deploy`, which stages the AppKit demo
+and deploys it to the FEVM workspace. That step is local only and is not
+recorded in the annotated tag.
+
+After bump, release writes `docs/releases/vX.Y.Z.md` with `dbx genie exec -C
+"$PWD" --sandbox read-only --ephemeral -o`. If Genie fails or writes an empty
+file, the step keeps going with a short git-log summary. `--no-release-notes`
+skips the file. Notes are committed with the version bump and are not recorded
+in the annotated tag. They are skipped on `--no-bump` because that path
+requires an already committed tree.
+
 `--install auto` keeps Projen's normal local dependency-install behavior;
 `always` performs a manifest-resolved install first, and `never` uses dependencies already
 installed while still regenerating versioned sources. `--no-validation` skips
@@ -553,6 +567,8 @@ release [options]
 | `--docs`                              | build and deploy docs for a selected scope                                                    |
 | `--no-docs`                           | skip documentation build and deployment                                                       |
 | `--no-validation`                     | skip optional release validation tasks; version/source checks remain mandatory                |
+| `--no-release-notes`                  | skip writing docs/releases notes (Genie and git-log fallback)                                 |
+| `--demo-deploy`                       | after tagging, stage and deploy the AppKit demo app (off by default)                          |
 | `--no-local-publish`                  | skip publishing to configured local registries                                                |
 | `--local-registry <auto\|false\|url>` | local npm registry selection (default: "auto")                                                |
 | `--local-pypi <auto\|false\|url>`     | local devpi registry selection (default: "auto")                                              |

package/index.ts

@@ -3,7 +3,7 @@
 // Hand edits are overwritten on the next watch; this file is read-only.
 
 export const PACKAGE_IDENTIFIER = "@dbx-tools/projen";
-export const PACKAGE_VERSION = "0.9.60";
+export const PACKAGE_VERSION = "0.9.61";
 export * as barrels from "./src/barrels.ts";
 export * as bunApp from "./src/bun-app.ts";
 export * as bunWorkflow from "./src/bun-workflow.ts";

package/package.json

@@ -30,9 +30,9 @@
   },
   "dependencies": {
     "@clack/prompts": "^1.7.0",
-    "@dbx-tools/core": "^0.9.60",
-    "@dbx-tools/path": "^0.9.60",
-    "@dbx-tools/shared-core": "^0.9.60",
+    "@dbx-tools/core": "^0.9.61",
+    "@dbx-tools/path": "^0.9.61",
+    "@dbx-tools/shared-core": "^0.9.61",
     "commander": "^15.0.0",
     "concurrently": "^10.0.3",
     "constructs": "^10.6.0",
@@ -54,7 +54,7 @@
   },
   "main": "index.ts",
   "license": "Apache-2.0",
-  "version": "0.9.60",
+  "version": "0.9.61",
   "types": "index.ts",
   "type": "module",
   "exports": {

package/src/_task-command.ts

@@ -69,6 +69,25 @@ export function captureTaskCommand(
   return result.exitCode === 0 ? (result.stdout?.trim() ?? "") : "";
 }
 
+/** Run a command with inherited output and return whether it exited successfully. */
+export function tryTaskCommand(
+  cwd: string,
+  command: string,
+  args: readonly string[],
+  options: TaskCommandOptions = {},
+): boolean {
+  return (
+    exec.spawnSync(executable(command), [...args], {
+      cwd,
+      env: options.env,
+      stdout: "inherit",
+      stderr: options.stderr ?? "inherit",
+      stdin: "ignore",
+      check: false,
+    }).exitCode === 0
+  );
+}
+
 /** Whether a quiet, non-interactive command exits successfully. */
 export function taskCommandSucceeds(
   cwd: string,

package/tasks/release-notes.ts

@@ -0,0 +1,97 @@
+/**
+ * Write user-facing release notes under `docs/releases/` during `bun run release`.
+ *
+ * Prefers Genie Code (`dbx genie exec`). When that fails or writes an empty
+ * file, falls back to a short git-log summary so the release still commits notes.
+ *
+ * @module
+ */
+
+import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { log } from "@dbx-tools/shared-core";
+
+import { captureTaskCommand, tryTaskCommand } from "../src/_task-command.ts";
+
+const logger = log.logger("projen:release-notes");
+
+const GENIE_PROMPT =
+  "Compare HEAD and the working tree against the latest v* tag. Produce concise user-facing release notes. Ignore generated-file churn and test-only changes. Include breaking changes, fixes, and validation results. Do not modify files.";
+
+/** Inputs for one notes write. */
+export interface WriteReleaseNotesOptions {
+  readonly prefix: string;
+  readonly root: string;
+  readonly version: string;
+  /** Override Genie invocation; return false to force the git-log fallback. */
+  readonly runGenie?: (args: readonly string[]) => boolean;
+}
+
+/** Path of the notes file for one workspace version. */
+export function releaseNotesPath(root: string, version: string): string {
+  return join(root, "docs", "releases", `v${version}.md`);
+}
+
+/** Short markdown notes from commit subjects since the previous matching tag. */
+export function fallbackReleaseNotes(
+  version: string,
+  commits: readonly string[],
+  previousTag?: string,
+): string {
+  const range = previousTag ? `since ${previousTag}` : "in this release";
+  const items =
+    commits.length > 0
+      ? commits.map((subject) => `- ${subject}`).join("\n")
+      : "- Version bump and synchronized package metadata.";
+  return `# Release ${version}\n\ndbx-tools ${version} ${range}.\n\n${items}\n`;
+}
+
+/** Run Genie into `docs/releases/vX.Y.Z.md`, or write {@link fallbackReleaseNotes}. */
+export function writeReleaseNotes(options: WriteReleaseNotesOptions): string {
+  const { prefix, root, version } = options;
+  const destination = releaseNotesPath(root, version);
+  mkdirSync(dirname(destination), { recursive: true });
+  const relative = join("docs", "releases", `v${version}.md`);
+  const genieArgs = [
+    "exec",
+    "-C",
+    root,
+    "--sandbox",
+    "read-only",
+    "--ephemeral",
+    "-o",
+    relative,
+    GENIE_PROMPT,
+  ] as const;
+  const ran =
+    options.runGenie?.([...genieArgs]) ??
+    tryTaskCommand(root, "bun", ["run", "dbx", "genie", ...genieArgs]);
+  if (ran && readNotes(destination)) {
+    logger.info("wrote Genie release notes", { path: relative });
+    return destination;
+  }
+  const previousTag = captureTaskCommand(root, "git", [
+    "describe",
+    "--tags",
+    "--abbrev=0",
+    `--match=${prefix}*`,
+  ]);
+  const logArgs = previousTag
+    ? ["log", "--no-merges", "--pretty=format:%s", `${previousTag}..HEAD`]
+    : ["log", "--no-merges", "--pretty=format:%s", "-15"];
+  const commits = captureTaskCommand(root, "git", logArgs)
+    .split("\n")
+    .map((line) => line.trim())
+    .filter(Boolean);
+  writeFileSync(destination, fallbackReleaseNotes(version, commits, previousTag || undefined));
+  logger.warn("Genie release notes unavailable; wrote git-log summary", { path: relative });
+  return destination;
+}
+
+function readNotes(path: string): string {
+  try {
+    return readFileSync(path, "utf8").trim();
+  } catch {
+    return "";
+  }
+}

package/tasks/release.ts

@@ -4,6 +4,7 @@ import * as projectUtils from "@dbx-tools/core/project-utils";
 import { log } from "@dbx-tools/shared-core";
 import { Command, Option } from "commander";
 import { publishLocalRelease } from "./local-publish.ts";
+import { writeReleaseNotes } from "./release-notes.ts";
 import { assertReleaseVersion } from "./release-version.ts";
 import { captureTaskCommand, runTaskCommand, taskCommandSucceeds } from "../src/_task-command.ts";
 import {
@@ -105,6 +106,11 @@ export async function runRelease(
     readonly install?: ReleaseInstallMode;
     readonly pythonRoot?: string;
     readonly validationTasks?: readonly string[];
+    /** After tagging, stage and deploy the AppKit demo app. Off by default. */
+    readonly demoDeploy?: boolean;
+    /** Write `docs/releases/vX.Y.Z.md` via Genie, with a git-log fallback. On by default. */
+    readonly releaseNotes?: boolean;
+    readonly writeReleaseNotes?: typeof writeReleaseNotes;
   },
 ): Promise<string> {
   const { branch, prefix, remote, root } = options;
@@ -125,6 +131,9 @@ export async function runRelease(
   const version = readWorkspaceVersion(root);
   const tag = `${prefix}${version}`;
   assertReleaseVersion(version, { root, prefixes: [prefix], assertNext: true });
+  if ((options.releaseNotes ?? true) && (options.bump ?? true)) {
+    (options.writeReleaseNotes ?? writeReleaseNotes)({ prefix, root, version });
+  }
 
   if (taskCommandSucceeds(root, "git", ["rev-parse", "--verify", `refs/tags/${tag}`])) {
     throw new Error(`release tag ${tag} already exists`);
@@ -190,6 +199,10 @@ export async function runRelease(
     });
   }
 
+  if (options.demoDeploy) {
+    runTaskCommand(root, "bun", ["run", "demo:deploy"]);
+  }
+
   return tag;
 }
 
@@ -228,6 +241,8 @@ export function createReleaseCommand(): Command {
       "--no-validation",
       "skip optional release validation tasks; version/source checks remain mandatory",
     )
+    .option("--no-release-notes", "skip writing docs/releases notes (Genie and git-log fallback)")
+    .option("--demo-deploy", "after tagging, stage and deploy the AppKit demo app (off by default)")
     .option("--no-local-publish", "skip publishing to configured local registries")
     .option("--local-registry <auto|false|url>", "local npm registry selection", "auto")
     .option("--local-pypi <auto|false|url>", "local devpi registry selection", "auto")
@@ -245,6 +260,8 @@ export function createReleaseCommand(): Command {
           localPypi: string;
           install: ReleaseInstallMode;
           validate: string[];
+          demoDeploy?: boolean;
+          releaseNotes?: boolean;
         },
       ) => {
         await runRelease({
@@ -264,6 +281,8 @@ export function createReleaseCommand(): Command {
           docs: options.docs,
           validation: options.validation,
           validationTasks: options.validate,
+          demoDeploy: options.demoDeploy,
+          releaseNotes: options.releaseNotes,
         });
       },
     );