@williamthorsen/release-kit 10.2.0 → 10.2.2

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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/release-kit",
-  "version": "10.2.0",
+  "version": "10.2.2",
   "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,7 +44,7 @@
     "semver": "7.8.5",
     "yaml": "2.9.0",
     "zod": "4.4.3",
-    "@williamthorsen/nmr-core": "0.9.0"
+    "@williamthorsen/nmr-core": "0.9.2"
   },
   "devDependencies": {
     "@types/semver": "7.7.1",

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/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}` };
-}