@ucdjs/release-scripts 0.1.0-beta.6 → 0.1.0-beta.61

package/README.md

@@ -1,3 +1,102 @@
 # @ucdjs/release-scripts
 
-This repository contains release and publish scripts for the UCDJS organization.
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+
+Monorepo release automation for pnpm workspaces. Handles version calculation, dependency graph resolution, changelog generation, and GitHub integration.
+
+## Installation
+
+```bash
+npm install @ucdjs/release-scripts
+```
+
+## Usage
+
+```typescript
+import { createReleaseScripts } from "@ucdjs/release-scripts";
+
+const release = await createReleaseScripts({
+  repo: "owner/repo",
+  githubToken: process.env.GITHUB_TOKEN,
+});
+
+// Prepare a release (calculate versions, update package.json files, create PR)
+const result = await release.prepare();
+
+// Verify a release branch matches expected state
+await release.verify();
+
+// Publish packages to npm
+await release.publish();
+```
+
+### Configuration
+
+```typescript
+const release = await createReleaseScripts({
+  repo: "owner/repo",
+  githubToken: "...",
+  workspaceRoot: process.cwd(),
+  dryRun: false,
+  safeguards: true,
+  globalCommitMode: "dependencies",
+  packages: {
+    include: ["@scope/pkg-a", "@scope/pkg-b"],
+    exclude: ["@scope/internal"],
+    excludePrivate: true,
+  },
+  branch: {
+    release: "release/next",
+    default: "main",
+  },
+  npm: {
+    provenance: true,
+    access: "public",
+  },
+  changelog: {
+    enabled: true,
+    emojis: true,
+  },
+});
+```
+
+### Package Discovery
+
+```typescript
+// List all workspace packages
+const packages = await release.packages.list();
+
+// Get a specific package
+const pkg = await release.packages.get("@scope/pkg-a");
+```
+
+### Workflows
+
+#### `prepare()`
+
+Calculates version bumps from conventional commits, updates `package.json` files, generates changelogs, and creates/updates a release pull request.
+
+#### `verify()`
+
+Validates that a release branch matches expected release artifacts. Compares expected vs actual versions and dependency ranges, then sets a GitHub commit status.
+
+#### `publish()`
+
+Publishes packages to npm in topological order with provenance support, creates git tags, and pushes them to the remote.
+
+## CLI Flags
+
+When used in a script, the following flags are supported:
+
+- `--dry` / `-d` - Dry-run mode, no changes are made
+- `--verbose` / `-v` - Enable verbose logging
+
+## 📄 License
+
+Published under [MIT License](./LICENSE).
+
+[npm-version-src]: https://img.shields.io/npm/v/@ucdjs/release-scripts?style=flat&colorA=18181B&colorB=4169E1
+[npm-version-href]: https://npmjs.com/package/@ucdjs/release-scripts
+[npm-downloads-src]: https://img.shields.io/npm/dm/@ucdjs/release-scripts?style=flat&colorA=18181B&colorB=4169E1
+[npm-downloads-href]: https://npmjs.com/package/@ucdjs/release-scripts

package/dist/{eta-Boh7yPZi.mjs → eta-g9ausaEx.mjs}

@@ -1,7 +1,6 @@
-import * as fs from "node:fs";
 import * as path from "node:path";
-
-//#region node_modules/.pnpm/eta@4.0.1/node_modules/eta/dist/index.js
+import * as fs from "node:fs";
+//#region node_modules/.pnpm/eta@4.5.1/node_modules/eta/dist/index.mjs
 var EtaError = class extends Error {
 	constructor(message) {
 		super(message);
@@ -53,6 +52,7 @@ function RuntimeErr(originalError, str, lineNo, path$1) {
 	}).join("\n");
 	const err = new EtaRuntimeError((filename ? filename + ":" + lineNo + "\n" : "line " + lineNo + "\n") + context + "\n\n" + originalError.message);
 	err.name = originalError.name;
+	err.cause = originalError;
 	throw err;
 }
 function readFile(path$1) {
@@ -121,8 +121,8 @@ function compileToString(str, options) {
 	const compileBody$1 = this.compileBody;
 	const buffer = this.parse.call(this, str);
 	let res = `${config.functionHeader}
-let include = (template, data) => this.render(template, data, options);
-let includeAsync = (template, data) => this.renderAsync(template, data, options);
+let include = (__eta_t, __eta_d) => this.render(__eta_t, {...${config.varName}, ...(__eta_d ?? {})}, options);
+let includeAsync = (__eta_t, __eta_d) => this.renderAsync(__eta_t, {...${config.varName}, ...(__eta_d ?? {})}, options);
 
 let __eta = {res: "", e: this.config.escapeFunction, f: this.config.filterFunction${config.debug ? ", line: 1, templateStr: \"" + str.replace(/\\|"/g, "\\$&").replace(/\r\n|\n|\r/g, "\\n") + "\"" : ""}};
 
@@ -131,6 +131,8 @@ function layout(path, data) {
   __eta.layoutData = data;
 }${config.debug ? "try {" : ""}${config.useWith ? "with(" + config.varName + "||{}){" : ""}
 
+function ${config.outputFunctionName}(s){__eta.res+=s;}
+
 ${compileBody$1.call(this, buffer)}
 if (__eta.layout) {
   __eta.res = ${isAsync ? "await includeAsync" : "include"} (__eta.layout, {...${config.varName}, body: __eta.res, ...__eta.layoutData});
@@ -162,18 +164,18 @@ function compileBody(buff) {
 	let returnStr = "";
 	for (; i < buffLength; i++) {
 		const currentBlock = buff[i];
-		if (typeof currentBlock === "string") returnStr += "__eta.res+='" + currentBlock + "'\n";
+		if (typeof currentBlock === "string") returnStr += "__eta.res+='" + currentBlock + "';\n";
 		else {
 			const type = currentBlock.t;
 			let content = currentBlock.val || "";
 			if (config.debug) returnStr += "__eta.line=" + currentBlock.lineNo + "\n";
 			if (type === "r") {
 				if (config.autoFilter) content = "__eta.f(" + content + ")";
-				returnStr += "__eta.res+=" + content + "\n";
+				returnStr += "__eta.res+=" + content + ";\n";
 			} else if (type === "i") {
 				if (config.autoFilter) content = "__eta.f(" + content + ")";
 				if (config.autoEscape) content = "__eta.e(" + content + ")";
-				returnStr += "__eta.res+=" + content + "\n";
+				returnStr += "__eta.res+=" + content + ";\n";
 			} else if (type === "e") returnStr += content + "\n";
 		}
 	}
@@ -233,6 +235,7 @@ const defaultConfig = {
 	debug: false,
 	escapeFunction: XMLEscape,
 	filterFunction: (val) => String(val),
+	outputFunctionName: "output",
 	functionHeader: "",
 	parse: {
 		exec: "",
@@ -472,6 +475,5 @@ var Eta = class extends Eta$1 {
 	readFile = readFile;
 	resolvePath = resolvePath;
 };
-
 //#endregion
-export { Eta as t };
+export { Eta as t };

package/dist/index.d.mts

@@ -1,4 +1,44 @@
-//#region src/workspace.d.ts
+//#region src/options.d.ts
+interface FindWorkspacePackagesOptions {
+  exclude?: string[];
+  include?: string[];
+  excludePrivate?: boolean;
+}
+interface ReleaseScriptsOptionsInput {
+  dryRun?: boolean;
+  repo: `${string}/${string}`;
+  workspaceRoot?: string;
+  packages?: true | FindWorkspacePackagesOptions | string[];
+  githubToken: string;
+  safeguards?: boolean;
+  branch?: {
+    release?: string;
+    default?: string;
+  };
+  globalCommitMode?: "dependencies" | "all" | "none";
+  pullRequest?: {
+    title?: string;
+    body?: string;
+  };
+  types?: Record<string, CommitTypeRule>;
+  changelog?: {
+    enabled?: boolean;
+    template?: string;
+    emojis?: boolean;
+    combinePrereleaseIntoFirstStable?: boolean;
+  };
+  npm?: {
+    otp?: string;
+    provenance?: boolean;
+    access?: "public" | "restricted";
+  };
+  prompts?: {
+    versions?: boolean;
+    packages?: boolean;
+  };
+}
+//#endregion
+//#region src/core/workspace.d.ts
 interface WorkspacePackage {
   name: string;
   version: string;
@@ -8,46 +48,17 @@ interface WorkspacePackage {
   workspaceDevDependencies: string[];
 }
 //#endregion
-//#region src/types.d.ts
+//#region src/shared/types.d.ts
 type BumpKind = "none" | "patch" | "minor" | "major";
-interface SharedOptions {
-  /**
-   * Repository identifier (e.g., "owner/repo")
-   */
-  repo: string;
+interface CommitTypeRule {
   /**
-   * Root directory of the workspace (defaults to process.cwd())
+   * Display title (e.g., "Features", "Bug Fixes")
    */
-  workspaceRoot?: string;
-  /**
-   * Specific packages to prepare for release.
-   * - true: discover all packages
-   * - FindWorkspacePackagesOptions: discover with filters
-   * - string[]: specific package names
-   */
-  packages?: true | FindWorkspacePackagesOptions | string[];
-  /**
-   * Whether to enable verbose logging
-   * @default false
-   */
-  verbose?: boolean;
-  /**
-   * GitHub token for authentication
-   */
-  githubToken: string;
+  title: string;
   /**
-   * Interactive prompt configuration
+   * Commit types to include in this group (defaults to the map key)
    */
-  prompts?: {
-    /**
-     * Enable package selection prompt (defaults to true when not in CI)
-     */
-    packages?: boolean;
-    /**
-     * Enable version override prompt (defaults to true when not in CI)
-     */
-    versions?: boolean;
-  };
+  types?: string[];
 }
 interface PackageJson {
   name: string;
@@ -58,21 +69,7 @@ interface PackageJson {
   private?: boolean;
   [key: string]: unknown;
 }
-interface FindWorkspacePackagesOptions {
-  /**
-   * Package names to exclude
-   */
-  exclude?: string[];
-  /**
-   * Only include these packages (if specified, all others are excluded)
-   */
-  include?: string[];
-  /**
-   * Whether to exclude private packages (default: false)
-   */
-  excludePrivate?: boolean;
-}
-interface VersionUpdate {
+interface PackageRelease {
   /**
    * The package being updated
    */
@@ -93,52 +90,18 @@ interface VersionUpdate {
    * Whether this package has direct changes (vs being updated due to dependency changes)
    */
   hasDirectChanges: boolean;
-}
-//#endregion
-//#region src/publish.d.ts
-interface PublishOptions extends SharedOptions {}
-declare function publish(_options: PublishOptions): void;
-//#endregion
-//#region src/release.d.ts
-interface ReleaseOptions extends SharedOptions {
   /**
-   * Branch name for the release PR (defaults to "release/next")
+   * Why/how this release entry exists.
    */
-  releaseBranch?: string;
-  /**
-   * Whether to perform a dry run (no changes pushed or PR created)
-   * @default false
-   */
-  dryRun?: boolean;
-  /**
-   * Whether to enable safety safeguards (e.g., checking for clean working directory)
-   * @default true
-   */
-  safeguards?: boolean;
-  /**
-   * Pull request configuration
-   */
-  pullRequest?: {
-    /**
-     * Title for the release pull request
-     */
-    title?: string;
-    /**
-     * Body for the release pull request
-     *
-     * If not provided, a default body will be generated.
-     *
-     * NOTE:
-     * You can use custom template expressions, see [h3js/rendu](https://github.com/h3js/rendu)
-     */
-    body?: string;
-  };
+  changeKind: "auto" | "manual" | "as-is" | "dependent";
 }
+//#endregion
+//#region src/types.d.ts
 interface ReleaseResult {
   /**
    * Packages that will be updated
    */
-  updates: VersionUpdate[];
+  updates: PackageRelease[];
   /**
    * URL of the created or updated PR
    */
@@ -148,6 +111,17 @@ interface ReleaseResult {
    */
   created: boolean;
 }
-declare function release(options: ReleaseOptions): Promise<ReleaseResult | null>;
 //#endregion
-export { type PublishOptions, type ReleaseOptions, type ReleaseResult, publish, release };
+//#region src/index.d.ts
+interface ReleaseScripts {
+  verify: () => Promise<void>;
+  prepare: () => Promise<ReleaseResult | null>;
+  publish: () => Promise<void>;
+  packages: {
+    list: () => Promise<WorkspacePackage[]>;
+    get: (packageName: string) => Promise<WorkspacePackage | undefined>;
+  };
+}
+declare function createReleaseScripts(options: ReleaseScriptsOptionsInput): Promise<ReleaseScripts>;
+//#endregion
+export { ReleaseScripts, createReleaseScripts };