@williamthorsen/release-kit 4.5.1 → 4.6.0

package/dist/esm/sync-labels/presets.js

@@ -1,3 +1,4 @@
+import { createHash } from "node:crypto";
 import { existsSync, readFileSync } from "node:fs";
 import { resolve } from "node:path";
 import { load } from "js-yaml";
@@ -7,6 +8,14 @@ function resolvePresetPath(presetName) {
   const root = findPackageRoot(import.meta.url);
   return resolve(root, "presets", "labels", `${presetName}.yaml`);
 }
+function hashPresetFile(presetName) {
+  const presetPath = resolvePresetPath(presetName);
+  if (!existsSync(presetPath)) {
+    throw new Error(`Unknown preset "${presetName}". No file found at ${presetPath}`);
+  }
+  const content = readFileSync(presetPath, "utf8");
+  return createHash("sha256").update(content).digest("hex");
+}
 function loadPreset(presetName) {
   const presetPath = resolvePresetPath(presetName);
   if (!existsSync(presetPath)) {
@@ -36,5 +45,6 @@ function loadPreset(presetName) {
   return labels;
 }
 export {
+  hashPresetFile,
   loadPreset
 };

package/dist/esm/typeGuards.d.ts

@@ -1 +1,2 @@
 export declare function isRecord(value: unknown): value is Record<string, unknown>;
+export declare function isUnknownArray(value: unknown): value is unknown[];

package/dist/esm/typeGuards.js

@@ -1,6 +1,10 @@
 function isRecord(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 }
+function isUnknownArray(value) {
+  return Array.isArray(value);
+}
 export {
-  isRecord
+  isRecord,
+  isUnknownArray
 };

package/dist/esm/types.d.ts

@@ -1,4 +1,27 @@
 export type ReleaseType = 'major' | 'minor' | 'patch';
+export type ChangelogAudience = 'all' | 'dev';
+export interface ChangelogItem {
+    description: string;
+}
+export interface ChangelogSection {
+    title: string;
+    audience: ChangelogAudience;
+    items: ChangelogItem[];
+}
+export interface ChangelogEntry {
+    version: string;
+    date: string;
+    sections: ChangelogSection[];
+}
+export interface ChangelogJsonConfig {
+    enabled: boolean;
+    outputPath: string;
+    devOnlySections: string[];
+}
+export interface ReleaseNotesConfig {
+    shouldInjectIntoReadme: boolean;
+    shouldCreateGithubRelease: boolean;
+}
 export interface PropagationSource {
     packageName: string;
     newVersion: string;
@@ -51,6 +74,8 @@ export interface ReleaseKitConfig {
     formatCommand?: string;
     cliffConfigPath?: string;
     scopeAliases?: Record<string, string>;
+    changelogJson?: Partial<ChangelogJsonConfig>;
+    releaseNotes?: Partial<ReleaseNotesConfig>;
 }
 export interface ComponentOverride {
     dir: string;
@@ -82,6 +107,8 @@ export interface MonorepoReleaseConfig {
     formatCommand?: string;
     cliffConfigPath?: string;
     scopeAliases?: Record<string, string>;
+    changelogJson: ChangelogJsonConfig;
+    releaseNotes: ReleaseNotesConfig;
 }
 export interface ReleaseConfig {
     tagPrefix: string;
@@ -92,4 +119,6 @@ export interface ReleaseConfig {
     formatCommand?: string;
     cliffConfigPath?: string;
     scopeAliases?: Record<string, string>;
+    changelogJson: ChangelogJsonConfig;
+    releaseNotes: ReleaseNotesConfig;
 }

package/dist/esm/validateConfig.d.ts

@@ -2,4 +2,5 @@ import type { ReleaseKitConfig } from './types.ts';
 export declare function validateConfig(raw: unknown): {
     config: ReleaseKitConfig;
     errors: string[];
+    warnings: string[];
 };

package/dist/esm/validateConfig.js

@@ -2,29 +2,112 @@ import { isRecord } from "./typeGuards.js";
 function validateConfig(raw) {
   const errors = [];
   if (!isRecord(raw)) {
-    return { config: {}, errors: ["Config must be an object"] };
+    return { config: {}, errors: ["Config must be an object"], warnings: [] };
   }
   const config = {};
   const knownFields = /* @__PURE__ */ new Set([
+    "changelogJson",
+    "cliffConfigPath",
     "components",
-    "versionPatterns",
-    "workTypes",
     "formatCommand",
-    "cliffConfigPath",
-    "scopeAliases"
+    "releaseNotes",
+    "scopeAliases",
+    "versionPatterns",
+    "workTypes"
   ]);
   for (const key of Object.keys(raw)) {
     if (!knownFields.has(key)) {
       errors.push(`Unknown field: '${key}'`);
     }
   }
+  validateChangelogJson(raw.changelogJson, config, errors);
   validateComponents(raw.components, config, errors);
+  validateReleaseNotes(raw.releaseNotes, config, errors);
   validateVersionPatterns(raw.versionPatterns, config, errors);
   validateWorkTypes(raw.workTypes, config, errors);
   validateStringField("formatCommand", raw.formatCommand, config, errors);
   validateStringField("cliffConfigPath", raw.cliffConfigPath, config, errors);
   validateScopeAliases(raw.scopeAliases, config, errors);
-  return { config, errors };
+  const warnings = [];
+  const changelogJsonEnabled = config.changelogJson?.enabled ?? true;
+  if (!changelogJsonEnabled) {
+    if (config.releaseNotes?.shouldCreateGithubRelease) {
+      warnings.push(
+        "releaseNotes.shouldCreateGithubRelease is enabled but changelogJson.enabled is false; GitHub Releases will be skipped at runtime"
+      );
+    }
+    if (config.releaseNotes?.shouldInjectIntoReadme) {
+      warnings.push(
+        "releaseNotes.shouldInjectIntoReadme is enabled but changelogJson.enabled is false; README injection will be skipped at runtime"
+      );
+    }
+  }
+  return { config, errors, warnings };
+}
+function validateChangelogJson(value, config, errors) {
+  if (value === void 0) return;
+  if (!isRecord(value)) {
+    errors.push("'changelogJson' must be an object");
+    return;
+  }
+  const knownChangelogJsonFields = /* @__PURE__ */ new Set(["enabled", "outputPath", "devOnlySections"]);
+  for (const key of Object.keys(value)) {
+    if (!knownChangelogJsonFields.has(key)) {
+      errors.push(`changelogJson: unknown field '${key}'`);
+    }
+  }
+  const result = {};
+  if (value.enabled !== void 0) {
+    if (typeof value.enabled === "boolean") {
+      result.enabled = value.enabled;
+    } else {
+      errors.push("changelogJson.enabled: must be a boolean");
+    }
+  }
+  if (value.outputPath !== void 0) {
+    if (typeof value.outputPath === "string") {
+      result.outputPath = value.outputPath;
+    } else {
+      errors.push("changelogJson.outputPath: must be a string");
+    }
+  }
+  if (value.devOnlySections !== void 0) {
+    if (isStringArray(value.devOnlySections)) {
+      result.devOnlySections = value.devOnlySections;
+    } else {
+      errors.push("changelogJson.devOnlySections: must be a string array");
+    }
+  }
+  config.changelogJson = result;
+}
+function validateReleaseNotes(value, config, errors) {
+  if (value === void 0) return;
+  if (!isRecord(value)) {
+    errors.push("'releaseNotes' must be an object");
+    return;
+  }
+  const knownReleaseNotesFields = /* @__PURE__ */ new Set(["shouldInjectIntoReadme", "shouldCreateGithubRelease"]);
+  for (const key of Object.keys(value)) {
+    if (!knownReleaseNotesFields.has(key)) {
+      errors.push(`releaseNotes: unknown field '${key}'`);
+    }
+  }
+  const result = {};
+  if (value.shouldInjectIntoReadme !== void 0) {
+    if (typeof value.shouldInjectIntoReadme === "boolean") {
+      result.shouldInjectIntoReadme = value.shouldInjectIntoReadme;
+    } else {
+      errors.push("releaseNotes.shouldInjectIntoReadme: must be a boolean");
+    }
+  }
+  if (value.shouldCreateGithubRelease !== void 0) {
+    if (typeof value.shouldCreateGithubRelease === "boolean") {
+      result.shouldCreateGithubRelease = value.shouldCreateGithubRelease;
+    } else {
+      errors.push("releaseNotes.shouldCreateGithubRelease: must be a boolean");
+    }
+  }
+  config.releaseNotes = result;
 }
 function isStringArray(value) {
   return Array.isArray(value) && value.every((item) => typeof item === "string");

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "4.5.1";
+export declare const VERSION = "4.6.0";

package/dist/esm/version.js

@@ -1,4 +1,4 @@
-const VERSION = "4.5.1";
+const VERSION = "4.6.0";
 export {
   VERSION
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/release-kit",
-  "version": "4.5.1",
+  "version": "4.6.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",
@@ -12,7 +12,7 @@
     "url": "https://github.com/williamthorsen/node-monorepo-tools.git",
     "directory": "packages/release-kit"
   },
-  "license": "UNLICENSED",
+  "license": "ISC",
   "author": "William Thorsen <william@thorsen.dev> (https://github.com/williamthorsen)",
   "type": "module",
   "exports": {
@@ -34,7 +34,8 @@
     "glob": "13.0.6",
     "jiti": "2.6.1",
     "js-yaml": "4.1.1",
-    "@williamthorsen/node-monorepo-core": "0.2.5"
+    "json-stringify-pretty-compact": "4.0.0",
+    "@williamthorsen/node-monorepo-core": "0.2.6"
   },
   "devDependencies": {
     "@types/js-yaml": "4.0.9",

package/presets/labels/common.yaml

@@ -11,9 +11,21 @@
 - name: documentation
   color: a2eeef
   description: Improvements or additions to documentation
+- name: deprecation
+  color: fbca04
+  description: Marks functionality for future removal
 - name: feature
   color: '0075ca'
   description: Added or improved external functionality
+- name: fix
+  color: d73a4a
+  description: Fixes a bug
+- name: performance
+  color: '0075ca'
+  description: Improves performance without changing behavior
+- name: security
+  color: b60205
+  description: Security vulnerability or hardening
 - name: spike
   color: '000000'
   description: Investigation
@@ -30,6 +42,9 @@
   description: Further information is needed
 
 # Refactoring
+- name: ci
+  color: edc287
+  description: CI/CD tooling & configuration
 - name: dependencies
   color: edc287
   description: Change to dependencies
@@ -46,6 +61,34 @@
   color: 1d76db
   description: Changed internal functionality
 
+# Priority
+- name: 'priority:critical'
+  color: b60205
+  description: Demands immediate attention
+- name: 'priority:high'
+  color: d93f0b
+  description: Address soon
+- name: 'priority:medium'
+  color: fbca04
+  description: No rush but don't forget
+- name: 'priority:low'
+  color: cfd3d7
+  description: Get to it eventually
+
+# Value
+- name: 'value:must-have'
+  color: 7057ff
+  description: Essential for the application to fulfill its purpose
+- name: 'value:should-have'
+  color: 8d83fc
+  description: Important but the application is usable without it
+- name: 'value:nice-to-have'
+  color: a8b2f8
+  description: A nice-to-have enhancement
+- name: 'value:questionable'
+  color: c5def5
+  description: Decision needed on whether this would add sufficient value
+
 # Triage
 - name: duplicate
   color: cfd3d7