@williamthorsen/release-kit 9.0.1 → 9.1.1

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## 9.1.0 — 2026-07-31
+
+### 🎉 Features
+
+- Make label descriptions optional and generate none for scope labels (#539)
+
+  `release-kit` now supports labels without a description, and `release-kit sync-labels init` generates scope labels without one. Applying a label without a description clears any existing description the repository carries for that label.
+
 ## 9.0.1 — 2026-07-30
 
 ### ⚙️ Tooling

package/README.md

@@ -730,7 +730,7 @@ export default defineConfig({
   repoLabels: {
     extends: ['common'],
     labels: {
-      'scope:my-package': { color: '00ff96', description: 'my-package package' }, // add
+      'scope:my-package': { color: '00ff96' }, // add, with no description
       bug: { color: 'b60205', description: 'Something broken' }, // replace the preset's `bug`
       wontfix: null, // remove the preset's `wontfix`
     },
@@ -741,7 +741,9 @@ export default defineConfig({
 The block declares the repository's label registry — the set of labels defined on the GitHub repo, distinct from labels applied to PRs and issues. Resolution is an ordered fold with last-writer-wins:
 
 1. Presets, in `extends` order — a later preset wins on a shared name.
-2. The `labels` record — an entry adds a label, replaces one an earlier layer defined, or removes it (`null`). A replacing entry supplies the full `{ color, description }`.
+2. The `labels` record — an entry adds a label, replaces one an earlier layer defined, or removes it (`null`). Replacement is wholesale: an entry omitting `description` resolves to no description rather than inheriting the one an earlier layer supplied.
+
+`description` is optional throughout, in a preset as in the `labels` record, and `sync-labels init` generates none for a scope label. The generated file spells an absent description `''` because `github-label-sync` reads an omitted description as "leave the label's current one alone"; the empty form clears it.
 
 Overlaps are never errors; order resolves them, and the committed `.github/labels.yaml` diff is where an unexpected change surfaces at review. The one config error is a dangling `null` — removing a name no preset defines — because that misstatement is invisible in the output diff.
 
@@ -750,7 +752,7 @@ Overlaps are never errors; order resolves them, and the committed `.github/label
 Label configuration formerly lived in a standalone `.config/sync-labels.config.ts` (`presets` + a `labels` array). To migrate:
 
 1. Move the preset list to `repoLabels.extends` in `.config/release-kit.config.ts`.
-2. Convert each `labels` array entry to a `'name': { color, description }` record entry under `repoLabels.labels`.
+2. Convert each `labels` array entry to a `'name': { color }` record entry under `repoLabels.labels`, adding `description` where the label carries one.
 3. Delete `.config/sync-labels.config.ts` and run `release-kit sync-labels generate`.
 
 The regenerated `.github/labels.yaml` differs only in its `# Source:` header line. Name collisions with preset labels, which the old format rejected, now mean your entry replaces the preset label.

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

@@ -13,7 +13,8 @@ export function formatLabelsYaml(labels, presetHashes) {
     for (const [name, hash] of [...presetHashes].sort(([a], [b]) => a.localeCompare(b))) {
         headerLines.push(`# ${name} preset hash: ${hash}`);
     }
-    const yamlBody = stringify(labels, { singleQuote: true, lineWidth: 0 });
+    const declared = labels.map((label) => ({ ...label, description: label.description ?? '' }));
+    const yamlBody = stringify(declared, { singleQuote: true, lineWidth: 0 });
     return headerLines.join('\n') + '\n' + yamlBody;
 }
 export async function loadRepoLabelsConfig() {

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

@@ -4,10 +4,6 @@ import { resolve } from 'node:path';
 import { findPackageRoot } from '@williamthorsen/nmr-core';
 import { parse } from 'yaml';
 import { isRecord } from "../typeGuards.js";
-function resolvePresetPath(presetName) {
-    const root = findPackageRoot(import.meta.url);
-    return resolve(root, 'presets', 'labels', `${presetName}.yaml`);
-}
 export function hashPresetFile(presetName) {
     const presetPath = resolvePresetPath(presetName);
     if (!existsSync(presetPath)) {
@@ -38,10 +34,17 @@ export function loadPreset(presetName) {
         if (!isRecord(entry)) {
             throw new Error(`Preset "${presetName}" contains an invalid label entry: ${JSON.stringify(entry)}`);
         }
-        if (typeof entry.name !== 'string' || typeof entry.color !== 'string' || typeof entry.description !== 'string') {
+        const { description } = entry;
+        if (typeof entry.name !== 'string' ||
+            typeof entry.color !== 'string' ||
+            (description !== undefined && typeof description !== 'string')) {
             throw new TypeError(`Preset "${presetName}" contains a label with invalid fields: ${JSON.stringify(entry)}`);
         }
-        labels.push({ name: entry.name, color: entry.color, description: entry.description });
+        labels.push({ name: entry.name, color: entry.color, ...(description !== undefined && { description }) });
     }
     return labels;
 }
+function resolvePresetPath(presetName) {
+    const root = findPackageRoot(import.meta.url);
+    return resolve(root, 'presets', 'labels', `${presetName}.yaml`);
+}

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

@@ -14,7 +14,11 @@ export function resolveLabels(config) {
             resolved.delete(name);
         }
         else {
-            resolved.set(name, { name, color: spec.color, description: spec.description });
+            resolved.set(name, {
+                name,
+                color: spec.color,
+                ...(spec.description !== undefined && { description: spec.description }),
+            });
         }
     }
     return sortLabels([...resolved.values()]);

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

@@ -39,17 +39,8 @@ jobs:
 `;
 }
 export function buildScopeLabels(workspacePaths, retiredNames = []) {
-    const labels = [
-        { name: 'scope:root', color: '00ff96', description: 'Monorepo root configuration' },
-    ];
-    for (const workspacePath of workspacePaths) {
-        const name = basename(workspacePath);
-        labels.push({ name: `scope:${name}`, color: '00ff96', description: `${name} package` });
-    }
-    for (const retiredName of retiredNames) {
-        labels.push({ name: `scope:${retiredName}`, color: '00ff96', description: `${retiredName} package (retired)` });
-    }
-    return labels;
+    const scopes = ['root', ...workspacePaths.map((workspacePath) => basename(workspacePath)), ...retiredNames];
+    return scopes.map((scope) => ({ name: `scope:${scope}`, color: '00ff96' }));
 }
 function escapeForSingleQuotedString(value) {
     return value.replace(/\\/g, '\\\\').replace(/'/g, String.raw `\'`);
@@ -59,8 +50,8 @@ export function renderRepoLabelsBlock(scopeLabels) {
         .map((label) => {
         const name = escapeForSingleQuotedString(label.name);
         const color = escapeForSingleQuotedString(label.color);
-        const description = escapeForSingleQuotedString(label.description);
-        return `      '${name}': { color: '${color}', description: '${description}' },`;
+        const descriptionClause = label.description === undefined ? '' : `, description: '${escapeForSingleQuotedString(label.description)}'`;
+        return `      '${name}': { color: '${color}'${descriptionClause} },`;
     })
         .join('\n');
     const labelsBlock = entries === '' ? '    labels: {},' : `    labels: {\n${entries}\n    },`;

package/dist/esm/sync-labels/types.d.ts

@@ -1,5 +1,5 @@
 export interface LabelDefinition {
     name: string;
     color: string;
-    description: string;
+    description?: string;
 }

package/dist/esm/types.d.ts

@@ -173,14 +173,14 @@ export declare const breakingPolicyValueSchema: z.ZodEnum<{
 }>;
 export declare const labelSpecSchema: z.ZodObject<{
     color: z.ZodString;
-    description: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
 export type LabelSpec = z.infer<typeof labelSpecSchema>;
 export declare const repoLabelsSchema: z.ZodObject<{
     extends: z.ZodOptional<z.ZodArray<z.ZodString>>;
     labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodObject<{
         color: z.ZodString;
-        description: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>>>>;
 }, z.core.$strict>;
 export type RepoLabelsConfig = z.infer<typeof repoLabelsSchema>;
@@ -207,7 +207,7 @@ export declare const releaseKitConfigSchema: z.ZodObject<{
         extends: z.ZodOptional<z.ZodArray<z.ZodString>>;
         labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodObject<{
             color: z.ZodString;
-            description: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>>>;
     }, z.core.$strict>>;
     retiredPackages: z.ZodOptional<z.ZodArray<z.ZodObject<{

package/dist/esm/types.js

@@ -52,7 +52,7 @@ export const breakingPolicyValueSchema = z.enum(['forbidden', 'optional', 'requi
 export const labelSpecSchema = z
     .object({
     color: z.string().min(1),
-    description: z.string(),
+    description: z.string().optional(),
 })
     .strict();
 export const repoLabelsSchema = z

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/release-kit",
-  "version": "9.0.1",
+  "version": "9.1.1",
   "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",