@williamthorsen/release-kit 10.2.1 → 10.3.0

package/dist/esm/types.d.ts

@@ -39,11 +39,6 @@ export interface PropagationSource {
     packageName: string;
     newVersion: string;
 }
-export interface BumpResult {
-    currentVersion: string;
-    newVersion: string;
-    files: string[];
-}
 export interface PolicyViolation {
     commitHash: string;
     commitSubject: string;
@@ -64,6 +59,7 @@ export interface ReleasedWorkspaceResult {
     tag: string;
     bumpedFiles: string[];
     changelogFiles: string[];
+    previewFiles?: string[];
     commits?: Commit[];
     bumpOverride?: ReleaseType;
     propagatedFrom?: PropagationSource[];
@@ -93,6 +89,7 @@ export interface ReleasedProjectResult {
     tag: string;
     bumpedFiles: string[];
     changelogFiles: string[];
+    previewFiles?: string[];
     commits: Commit[];
     bumpOverride?: ReleaseType;
 }
@@ -111,10 +108,8 @@ export interface PrepareResult {
     tags: string[];
     formatCommand?: {
         command: string;
-        executed: boolean;
         files: string[];
     } | undefined;
-    dryRun: boolean;
     warnings?: string[] | undefined;
     project?: ProjectPrepareResult | undefined;
 }
@@ -167,8 +162,8 @@ export declare const versionPatternsSchema: z.ZodObject<{
     minor: z.ZodArray<z.ZodString>;
 }, z.core.$strict>;
 export declare const breakingPolicyValueSchema: z.ZodEnum<{
-    optional: "optional";
     forbidden: "forbidden";
+    optional: "optional";
     required: "required";
 }>;
 export declare const labelSpecSchema: z.ZodObject<{
@@ -186,8 +181,8 @@ export declare const repoLabelsSchema: z.ZodObject<{
 export type RepoLabelsConfig = z.infer<typeof repoLabelsSchema>;
 export declare const releaseKitConfigSchema: z.ZodObject<{
     breakingPolicies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<{
-        optional: "optional";
         forbidden: "forbidden";
+        optional: "optional";
         required: "required";
     }>>>;
     changelogJson: z.ZodOptional<z.ZodObject<{

package/dist/esm/validateConfig.js

@@ -30,25 +30,25 @@ function preprocessDeprecatedKeys(raw) {
         return { cleaned: raw, deprecationErrors: [] };
     const errors = [];
     const cleaned = { ...raw };
-    if (isRecord(cleaned.releaseNotes) && 'shouldCreateGithubRelease' in cleaned.releaseNotes) {
+    if (isRecord(cleaned['releaseNotes']) && Object.hasOwn(cleaned['releaseNotes'], 'shouldCreateGithubRelease')) {
         errors.push('releaseNotes.shouldCreateGithubRelease is no longer supported. Adoption is now signaled by installing the create-github-release workflow. Remove this field from your config; see README for the updated workflow.');
-        const releaseNotesCopy = { ...cleaned.releaseNotes };
-        delete releaseNotesCopy.shouldCreateGithubRelease;
-        cleaned.releaseNotes = releaseNotesCopy;
+        const releaseNotesCopy = { ...cleaned['releaseNotes'] };
+        delete releaseNotesCopy['shouldCreateGithubRelease'];
+        cleaned['releaseNotes'] = releaseNotesCopy;
     }
-    if (Array.isArray(cleaned.workspaces)) {
-        cleaned.workspaces = cleaned.workspaces.map((ws, i) => {
+    if (Array.isArray(cleaned['workspaces'])) {
+        cleaned['workspaces'] = cleaned['workspaces'].map((ws, i) => {
             if (!isRecord(ws))
                 return ws;
             const wsCopy = { ...ws };
-            if ('tagPrefix' in wsCopy) {
-                const dir = typeof wsCopy.dir === 'string' && wsCopy.dir !== '' ? wsCopy.dir : '<dir>';
+            if (Object.hasOwn(wsCopy, 'tagPrefix')) {
+                const dir = typeof wsCopy['dir'] === 'string' && wsCopy['dir'] !== '' ? wsCopy['dir'] : '<dir>';
                 errors.push(`workspaces[${i}]: 'tagPrefix' is no longer supported; remove it to use the default '${dir}-v'`);
-                delete wsCopy.tagPrefix;
+                delete wsCopy['tagPrefix'];
             }
-            if ('legacyTagPrefixes' in wsCopy) {
+            if (Object.hasOwn(wsCopy, 'legacyTagPrefixes')) {
                 errors.push(`workspaces[${i}]: 'legacyTagPrefixes' is no longer supported; use 'legacyIdentities: [{ name, tagPrefix }, ...]' instead`);
-                delete wsCopy.legacyTagPrefixes;
+                delete wsCopy['legacyTagPrefixes'];
             }
             return wsCopy;
         });

package/dist/esm/workTypesData.d.ts

@@ -15,8 +15,8 @@ export interface WorkTypesData {
     tiers: string[];
     types: WorkTypeEntry[];
     markers: {
-        breaking: MarkerEntry;
         [key: string]: MarkerEntry;
+        breaking: MarkerEntry;
     };
 }
 export declare const WORK_TYPES_DATA: WorkTypesData;

package/dist/esm/workTypesUtils.js

@@ -11,7 +11,7 @@ export function errorMessage(error) {
     return error instanceof Error ? error.message : String(error);
 }
 export function buildFetchInit() {
-    const token = process.env.GITHUB_TOKEN;
+    const token = process.env['GITHUB_TOKEN'];
     if (token === undefined || token === '') {
         return undefined;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/release-kit",
-  "version": "10.2.1",
+  "version": "10.3.0",
   "description": "Version-bumping and changelog-generation toolkit for release workflows",
   "keywords": [],
   "homepage": "https://github.com/williamthorsen/node-monorepo-tools/tree/main/packages/release-kit#readme",
@@ -44,11 +44,11 @@
     "semver": "7.8.5",
     "yaml": "2.9.0",
     "zod": "4.4.3",
-    "@williamthorsen/nmr-core": "0.9.1"
+    "@williamthorsen/nmr-core": "0.9.3"
   },
   "devDependencies": {
     "@types/semver": "7.7.1",
-    "readyup": "0.23.0",
+    "readyup": "0.24.0",
     "smol-toml": "1.7.1"
   },
   "engines": {

package/dist/esm/bumpAllVersions.d.ts

@@ -1,3 +0,0 @@
-import type { BumpResult, ReleaseType } from './types.js';
-export declare function bumpAllVersions(packageFiles: readonly string[], releaseType: ReleaseType, dryRun: boolean): BumpResult;
-export declare function setAllVersions(packageFiles: readonly string[], newVersion: string, dryRun: boolean): BumpResult;

package/dist/esm/bumpAllVersions.js

@@ -1,61 +0,0 @@
-import { readFileSync, writeFileSync } from 'node:fs';
-import { bumpVersion } from "./bumpVersion.js";
-function isPackageJson(value) {
-    return typeof value === 'object' && value !== null && 'version' in value && typeof value.version === 'string';
-}
-export function bumpAllVersions(packageFiles, releaseType, dryRun) {
-    const firstFile = packageFiles[0];
-    if (firstFile === undefined) {
-        throw new Error('No package files specified');
-    }
-    const firstPkg = readPackageJson(firstFile);
-    const currentVersion = firstPkg.version;
-    const newVersion = bumpVersion(currentVersion, releaseType);
-    writeVersionToAllFiles(packageFiles, firstFile, firstPkg, newVersion, dryRun);
-    return { currentVersion, newVersion, files: [...packageFiles] };
-}
-export function setAllVersions(packageFiles, newVersion, dryRun) {
-    const firstFile = packageFiles[0];
-    if (firstFile === undefined) {
-        throw new Error('No package files specified');
-    }
-    const firstPkg = readPackageJson(firstFile);
-    const currentVersion = firstPkg.version;
-    writeVersionToAllFiles(packageFiles, firstFile, firstPkg, newVersion, dryRun);
-    return { currentVersion, newVersion, files: [...packageFiles] };
-}
-function writeVersionToAllFiles(packageFiles, firstFile, firstPkg, newVersion, dryRun) {
-    for (const filePath of packageFiles) {
-        if (dryRun) {
-            continue;
-        }
-        const pkg = filePath === firstFile ? firstPkg : readPackageJson(filePath);
-        pkg.version = newVersion;
-        try {
-            writeFileSync(filePath, JSON.stringify(pkg, null, 2) + '\n', 'utf8');
-        }
-        catch (error) {
-            throw new Error(`Failed to write ${filePath}: ${error instanceof Error ? error.message : String(error)}`);
-        }
-    }
-}
-function readPackageJson(filePath) {
-    let content;
-    try {
-        content = readFileSync(filePath, 'utf8');
-    }
-    catch (error) {
-        throw new Error(`Failed to read ${filePath}: ${error instanceof Error ? error.message : String(error)}`);
-    }
-    let parsed;
-    try {
-        parsed = JSON.parse(content);
-    }
-    catch (error) {
-        throw new Error(`Failed to parse JSON in ${filePath}: ${error instanceof Error ? error.message : String(error)}`);
-    }
-    if (!isPackageJson(parsed)) {
-        throw new Error(`No valid 'version' field found in ${filePath}`);
-    }
-    return parsed;
-}

package/dist/esm/writeReleaseNotesPreviews.d.ts

@@ -1,18 +0,0 @@
-export interface WriteReleaseNotesPreviewsOptions {
-    workspacePath: string;
-    tag: string;
-    changelogJsonPath: string;
-    sectionOrder: string[];
-    dryRun: boolean;
-}
-export interface PreviewFileResult {
-    filePath: string;
-    outcome: 'created' | 'overwritten' | 'skipped-no-readme' | 'failed' | 'dry-run';
-    error?: string;
-}
-export interface WriteReleaseNotesPreviewsResult {
-    injectedReadme?: PreviewFileResult;
-    releaseNotes?: PreviewFileResult;
-    renderSkipped: boolean;
-}
-export declare function writeReleaseNotesPreviews(options: WriteReleaseNotesPreviewsOptions): WriteReleaseNotesPreviewsResult;

package/dist/esm/writeReleaseNotesPreviews.js

@@ -1,63 +0,0 @@
-import { existsSync, readFileSync } from 'node:fs';
-import path from 'node:path';
-import { reportError, writeFileWithCheck } from '@williamthorsen/nmr-core';
-import { extractVersion } from "./changelogJsonUtils.js";
-import { dim } from "./format.js";
-import { renderInjectedReadme } from "./injectReleaseNotesIntoReadme.js";
-export function writeReleaseNotesPreviews(options) {
-    const { workspacePath, tag, changelogJsonPath, sectionOrder, dryRun } = options;
-    const version = extractVersion(tag);
-    const readmePath = path.join(workspacePath, 'README.md');
-    let readmeExists = existsSync(readmePath);
-    let readmeUnreadable = false;
-    let readmeContent = '';
-    if (readmeExists) {
-        try {
-            readmeContent = readFileSync(readmePath, 'utf8');
-        }
-        catch (error) {
-            const message = error instanceof Error ? error.message : String(error);
-            console.warn(`Warning: failed to read ${readmePath}: ${message}; skipping injected-README preview`);
-            readmeExists = false;
-            readmeUnreadable = true;
-        }
-    }
-    const rendered = renderInjectedReadme(readmeContent, changelogJsonPath, tag, sectionOrder);
-    if (rendered === undefined) {
-        return { renderSkipped: true };
-    }
-    const docsDir = path.join(workspacePath, 'docs');
-    const readmePreviewPath = path.join(docsDir, `README.v${version}.md`);
-    const releaseNotesPreviewPath = path.join(docsDir, `RELEASE_NOTES.v${version}.md`);
-    let injectedReadme;
-    if (readmeExists) {
-        injectedReadme = writePreviewFile(readmePreviewPath, rendered.injectedReadme, dryRun);
-    }
-    else {
-        if (!readmeUnreadable) {
-            console.warn(`Warning: ${readmePath} not found; skipping injected-README preview but still writing standalone release notes`);
-        }
-        injectedReadme = { filePath: readmePreviewPath, outcome: 'skipped-no-readme' };
-    }
-    const releaseNotesContent = rendered.releaseNotesMarkdown.endsWith('\n')
-        ? rendered.releaseNotesMarkdown
-        : `${rendered.releaseNotesMarkdown}\n`;
-    const releaseNotes = writePreviewFile(releaseNotesPreviewPath, releaseNotesContent, dryRun);
-    return { injectedReadme, releaseNotes, renderSkipped: false };
-}
-function writePreviewFile(filePath, content, dryRun) {
-    if (dryRun) {
-        console.info(dim(`  [dry-run] Would write ${filePath}`));
-        return { filePath, outcome: 'dry-run' };
-    }
-    const result = writeFileWithCheck(filePath, content, { dryRun: false, overwrite: true });
-    if (result.outcome === 'failed') {
-        reportError(`Failed to write ${filePath}: ${result.error ?? 'unknown error'}`);
-        return { filePath, outcome: 'failed', ...(result.error !== undefined && { error: result.error }) };
-    }
-    if (result.outcome === 'created' || result.outcome === 'overwritten') {
-        console.info(dim(`  Wrote ${filePath}`));
-        return { filePath, outcome: result.outcome };
-    }
-    return { filePath, outcome: 'failed', error: `unexpected outcome: ${result.outcome}` };
-}