@releasekit/release 0.3.1 → 0.4.1

package/README.md

@@ -1,6 +1,10 @@
 # @releasekit/release
 
-Unified release pipeline: version, changelog, and publish in a single command.
+[![@releasekit/release](https://img.shields.io/badge/@releasekit-release-9feaf9?labelColor=1a1a1a&style=plastic)](https://www.npmjs.com/package/@releasekit/release)
+[![Version](https://img.shields.io/npm/v/@releasekit/release?color=28a745&labelColor=1a1a1a)](https://www.npmjs.com/package/@releasekit/release)
+[![Downloads](https://img.shields.io/npm/dw/@releasekit/release?color=6f42c1&labelColor=1a1a1a)](https://www.npmjs.com/package/@releasekit/release)
+
+**Unified release pipeline: version, changelog, and publish in a single command.**
 
 ## Features
 
@@ -71,6 +75,18 @@ If no releasable changes are found after step 1, the command exits with code 0 a
 | `-q, --quiet` | Suppress non-error output | `false` |
 | `--project-dir <path>` | Project directory | cwd |
 
+### `releasekit init`
+
+Create a default `releasekit.config.json` in the current directory.
+
+```bash
+releasekit init [--force]
+```
+
+Detects monorepo layout and sets `changelog.mode` accordingly. Adds `access: "public"` only for scoped packages (`@scope/name`), which npm defaults to restricted.
+
+Use `--force` to overwrite an existing config file.
+
 ### `releasekit preview`
 
 Posts a release preview comment on a pull request showing what would be released if merged.
@@ -275,6 +291,11 @@ jobs:
 
 A template is also available at [`templates/workflows/release-preview.yml`](../../templates/workflows/release-preview.yml).
 
+## Documentation
+
+**Getting Started**
+- [CI Setup](./docs/ci-setup.md) — GitHub Actions workflows (push, label, OIDC, PR preview, prerelease)
+
 ## License
 
 MIT

package/dist/{chunk-J5NT6OX2.js → chunk-I5CGC253.js}

@@ -5,7 +5,7 @@ import {
   runRelease,
   success,
   warn
-} from "./chunk-I5ABZWVU.js";
+} from "./chunk-YZHGXRG6.js";
 
 // src/preview-context.ts
 import * as fs from "fs";
@@ -98,15 +98,15 @@ var TYPE_LABELS = {
 function getNoChangesMessage(strategy) {
   switch (strategy) {
     case "manual":
-      return "> No releasable changes detected. Run the release workflow manually if a release is needed.";
+      return "Run the release workflow manually if a release is needed.";
     case "direct":
-      return "> No releasable changes detected. Merging this PR will not trigger a release.";
+      return "Merging this PR will not trigger a release.";
     case "standing-pr":
-      return "> No releasable changes detected. Merging this PR will not affect the release PR.";
+      return "Merging this PR will not affect the release PR.";
     case "scheduled":
-      return "> No releasable changes detected. These changes will not be included in the next scheduled release.";
+      return "These changes will not be included in the next scheduled release.";
     default:
-      return "> No releasable changes detected.";
+      return "";
   }
 }
 function getIntroMessage(strategy, standingPrNumber) {
@@ -125,20 +125,20 @@ function getLabelBanner(labelContext) {
   if (!labelContext) return [];
   if (labelContext.trigger === "commit") {
     if (labelContext.skip) {
-      return ["> [!WARNING]", "> This PR is marked to skip release.", ""];
+      return ["> **Warning:** This PR is marked to skip release.", ""];
     }
     if (labelContext.bumpLabel === "major") {
-      return ["> [!IMPORTANT]", "> This PR is labeled for a **major** release.", ""];
+      return ["> **Important:** This PR is labeled for a **major** release.", ""];
     }
   }
   if (labelContext.trigger === "label") {
     if (labelContext.noBumpLabel) {
       const labels = labelContext.labels;
       const labelExamples = labels ? `\`${labels.patch}\`, \`${labels.minor}\`, or \`${labels.major}\`` : "a release label (e.g., `release:patch`, `release:minor`, `release:major`)";
-      return ["> [!NOTE]", `> No release label detected. Add ${labelExamples} to trigger a release.`, ""];
+      return ["> No release label detected.", `> **Note:** Add ${labelExamples} to trigger a release.`, ""];
     }
     if (labelContext.bumpLabel) {
-      return ["> [!NOTE]", `> This PR is labeled for a **${labelContext.bumpLabel}** release.`, ""];
+      return [`> This PR is labeled for a **${labelContext.bumpLabel}** release.`, ""];
     }
   }
   return [];
@@ -152,7 +152,7 @@ function formatPreviewComment(result, options) {
     lines.push("<details>", "<summary><b>Release Preview</b> \u2014 no release</summary>", "");
     lines.push(...banner);
     if (!labelContext?.noBumpLabel) {
-      lines.push("> [!NOTE]", getNoChangesMessage(strategy));
+      lines.push(`> **Note:** No releasable changes detected. ${getNoChangesMessage(strategy)}`);
     }
     lines.push("", "---", FOOTER, "</details>");
     return lines.join("\n");

package/dist/{chunk-EDF3BZFF.js → chunk-WNKYXS62.js}

@@ -1,12 +1,12 @@
 import {
   EXIT_CODES,
   runRelease
-} from "./chunk-I5ABZWVU.js";
+} from "./chunk-YZHGXRG6.js";
 
 // src/release-command.ts
-import { Command } from "commander";
+import { Command, Option } from "commander";
 function createReleaseCommand() {
-  return new Command("release").description("Run the full release pipeline").option("-c, --config <path>", "Path to config file").option("-d, --dry-run", "Preview all steps without side effects", false).option("-b, --bump <type>", "Force bump type (patch|minor|major)").option("-p, --prerelease [identifier]", "Create prerelease version").option("-s, --sync", "Use synchronized versioning across all packages", false).option("-t, --target <packages>", "Target specific packages (comma-separated)").option("--branch <name>", "Override the git branch used for push").option("--skip-notes", "Skip changelog generation", false).option("--skip-publish", "Skip registry publishing and git operations", false).option("--skip-git", "Skip git commit/tag/push", false).option("--skip-github-release", "Skip GitHub release creation", false).option("--skip-verification", "Skip post-publish verification", false).option("-j, --json", "Output results as JSON", false).option("-v, --verbose", "Verbose logging", false).option("-q, --quiet", "Suppress non-error output", false).option("--project-dir <path>", "Project directory", process.cwd()).action(async (opts) => {
+  return new Command("release").description("Run the full release pipeline").option("-c, --config <path>", "Path to config file").option("-d, --dry-run", "Preview all steps without side effects", false).option("-b, --bump <type>", "Force bump type (patch|minor|major)").option("-p, --prerelease [identifier]", "Create prerelease version").option("-s, --sync", "Use synchronized versioning across all packages", false).option("-t, --target <packages>", "Target specific packages (comma-separated)").option("--branch <name>", "Override the git branch used for push").addOption(new Option("--npm-auth <method>", "NPM auth method").choices(["auto", "oidc", "token"]).default("auto")).option("--skip-notes", "Skip changelog generation", false).option("--skip-publish", "Skip registry publishing and git operations", false).option("--skip-git", "Skip git commit/tag/push", false).option("--skip-github-release", "Skip GitHub release creation", false).option("--skip-verification", "Skip post-publish verification", false).option("-j, --json", "Output results as JSON", false).option("-v, --verbose", "Verbose logging", false).option("-q, --quiet", "Suppress non-error output", false).option("--project-dir <path>", "Project directory", process.cwd()).action(async (opts) => {
     const options = {
       config: opts.config,
       dryRun: opts.dryRun,
@@ -15,6 +15,7 @@ function createReleaseCommand() {
       sync: opts.sync,
       target: opts.target,
       branch: opts.branch,
+      npmAuth: opts.npmAuth,
       skipNotes: opts.skipNotes,
       skipPublish: opts.skipPublish,
       skipGit: opts.skipGit,

package/dist/{chunk-I5ABZWVU.js → chunk-YZHGXRG6.js}

@@ -208,14 +208,14 @@ var GitHubReleaseConfigSchema = z.object({
   perPackage: z.boolean().default(true),
   prerelease: z.union([z.literal("auto"), z.boolean()]).default("auto"),
   /**
-   * Controls how release notes are sourced for GitHub releases.
-   * - 'auto': Use RELEASE_NOTES.md if it exists, then per-package changelog
-   *   data from the version output, then GitHub's auto-generated notes.
-   * - 'github': Always use GitHub's auto-generated notes.
-   * - 'none': No notes body.
-   * - Any other string: Treated as a file path to read notes from.
+   * Controls the source for the GitHub release body.
+   * - 'auto': Use release notes if enabled, else changelog, else GitHub auto-generated.
+   * - 'releaseNotes': Use LLM-generated release notes (requires notes.releaseNotes.enabled: true).
+   * - 'changelog': Use formatted changelog entries.
+   * - 'generated': Use GitHub's auto-generated notes.
+   * - 'none': No body.
    */
-  releaseNotes: z.union([z.literal("auto"), z.literal("github"), z.literal("none"), z.string()]).default("auto")
+  body: z.enum(["auto", "releaseNotes", "changelog", "generated", "none"]).default("auto")
 });
 var VerifyRegistryConfigSchema = z.object({
   enabled: z.boolean().default(true),
@@ -259,7 +259,7 @@ var PublishConfigSchema = z.object({
     draft: true,
     perPackage: true,
     prerelease: "auto",
-    releaseNotes: "auto"
+    body: "auto"
   }),
   verify: VerifyConfigSchema.default({
     npm: {
@@ -280,10 +280,10 @@ var TemplateConfigSchema = z.object({
   path: z.string().optional(),
   engine: z.enum(["handlebars", "liquid", "ejs"]).optional()
 });
-var OutputConfigSchema = z.object({
-  format: z.enum(["markdown", "github-release", "json"]),
+var LocationModeSchema = z.enum(["root", "packages", "both"]);
+var ChangelogConfigSchema = z.object({
+  mode: LocationModeSchema.optional(),
   file: z.string().optional(),
-  options: z.record(z.string(), z.unknown()).optional(),
   templates: TemplateConfigSchema.optional()
 });
 var LLMOptionsSchema = z.object({
@@ -343,17 +343,20 @@ var LLMConfigSchema = z.object({
   scopes: ScopeConfigSchema.optional(),
   prompts: LLMPromptsConfigSchema.optional()
 });
+var ReleaseNotesConfigSchema = z.object({
+  mode: LocationModeSchema.optional(),
+  file: z.string().optional(),
+  templates: TemplateConfigSchema.optional(),
+  llm: LLMConfigSchema.optional()
+});
 var NotesInputConfigSchema = z.object({
   source: z.string().optional(),
   file: z.string().optional()
 });
 var NotesConfigSchema = z.object({
-  input: NotesInputConfigSchema.optional(),
-  output: z.array(OutputConfigSchema).default([{ format: "markdown", file: "CHANGELOG.md" }]),
-  monorepo: MonorepoConfigSchema.optional(),
-  templates: TemplateConfigSchema.optional(),
-  llm: LLMConfigSchema.optional(),
-  updateStrategy: z.enum(["prepend", "regenerate"]).default("prepend")
+  changelog: z.union([z.literal(false), ChangelogConfigSchema]).optional(),
+  releaseNotes: z.union([z.literal(false), ReleaseNotesConfigSchema]).optional(),
+  updateStrategy: z.enum(["prepend", "regenerate"]).optional()
 });
 var CILabelsConfigSchema = z.object({
   stable: z.string().default("release:stable"),
@@ -554,11 +557,13 @@ async function runRelease(inputOptions) {
   }
   let notesGenerated = false;
   let packageNotes;
+  let releaseNotes;
   let notesFiles = [];
   if (!options.skipNotes) {
     info("Generating release notes...");
     const notesResult = await runNotesStep(versionOutput, options);
     packageNotes = notesResult.packageNotes;
+    releaseNotes = notesResult.releaseNotes;
     notesFiles = notesResult.files;
     notesGenerated = true;
     success("Release notes generated");
@@ -566,10 +571,10 @@ async function runRelease(inputOptions) {
   let publishOutput;
   if (!options.skipPublish) {
     info("Publishing...");
-    publishOutput = await runPublishStep(versionOutput, options, packageNotes, notesFiles);
+    publishOutput = await runPublishStep(versionOutput, options, releaseNotes ?? packageNotes, notesFiles);
     success("Publish complete");
   }
-  return { versionOutput, notesGenerated, packageNotes, publishOutput };
+  return { versionOutput, notesGenerated, packageNotes, releaseNotes, publishOutput };
 }
 async function runVersionStep(options) {
   const { loadConfig: loadConfig2, VersionEngine, enableJsonOutput, getJsonData } = await import("@releasekit/version");
@@ -605,14 +610,11 @@ async function runVersionStep(options) {
   return getJsonData();
 }
 async function runNotesStep(versionOutput, options) {
-  const { parseVersionOutput, runPipeline, loadConfig: loadConfig2, getDefaultConfig } = await import("@releasekit/notes");
+  const { parseVersionOutput, runPipeline, loadConfig: loadConfig2 } = await import("@releasekit/notes");
   const config = loadConfig2(options.projectDir, options.config);
-  if (config.output.length === 0) {
-    config.output = getDefaultConfig().output;
-  }
   const input = parseVersionOutput(JSON.stringify(versionOutput));
   const result = await runPipeline(input, config, options.dryRun);
-  return { packageNotes: result.packageNotes, files: result.files };
+  return { packageNotes: result.packageNotes, releaseNotes: result.releaseNotes, files: result.files };
 }
 async function runPublishStep(versionOutput, options, releaseNotes, additionalFiles) {
   const { runPipeline, loadConfig: loadConfig2 } = await import("@releasekit/publish");
@@ -623,7 +625,7 @@ async function runPublishStep(versionOutput, options, releaseNotes, additionalFi
   const publishOptions = {
     dryRun: options.dryRun,
     registry: "all",
-    npmAuth: "auto",
+    npmAuth: options.npmAuth ?? "auto",
     skipGit: options.skipGit,
     skipPublish: false,
     skipGithubRelease: options.skipGithubRelease,
@@ -638,6 +640,7 @@ async function runPublishStep(versionOutput, options, releaseNotes, additionalFi
 
 export {
   readPackageVersion,
+  error,
   warn,
   info,
   success,

package/dist/cli.js

@@ -1,14 +1,14 @@
 #!/usr/bin/env node
 import {
   createReleaseCommand
-} from "./chunk-EDF3BZFF.js";
+} from "./chunk-WNKYXS62.js";
 import {
   runPreview
-} from "./chunk-J5NT6OX2.js";
+} from "./chunk-I5CGC253.js";
 import {
   EXIT_CODES,
   readPackageVersion
-} from "./chunk-I5ABZWVU.js";
+} from "./chunk-YZHGXRG6.js";
 
 // src/cli.ts
 import { realpathSync } from "fs";

package/dist/dispatcher.js

@@ -1,10 +1,14 @@
 #!/usr/bin/env node
 import {
   createReleaseCommand
-} from "./chunk-EDF3BZFF.js";
+} from "./chunk-WNKYXS62.js";
 import {
-  readPackageVersion
-} from "./chunk-I5ABZWVU.js";
+  EXIT_CODES,
+  error,
+  info,
+  readPackageVersion,
+  success
+} from "./chunk-YZHGXRG6.js";
 
 // src/dispatcher.ts
 import { realpathSync } from "fs";
@@ -12,10 +16,62 @@ import { fileURLToPath } from "url";
 import { createNotesCommand } from "@releasekit/notes/cli";
 import { createPublishCommand } from "@releasekit/publish/cli";
 import { createVersionCommand } from "@releasekit/version/cli";
+import { Command as Command2 } from "commander";
+
+// src/init-command.ts
+import * as fs from "fs";
+import { detectMonorepo } from "@releasekit/notes";
 import { Command } from "commander";
+function createInitCommand() {
+  return new Command("init").description("Create a default releasekit.config.json").option("-f, --force", "Overwrite existing config").action((options) => {
+    const configPath = "releasekit.config.json";
+    if (fs.existsSync(configPath) && !options.force) {
+      error(`Config file already exists at ${configPath}. Use --force to overwrite.`);
+      process.exit(EXIT_CODES.GENERAL_ERROR);
+    } else {
+      let changelogMode;
+      try {
+        const detected = detectMonorepo(process.cwd());
+        changelogMode = detected.isMonorepo ? "packages" : "root";
+        info(
+          detected.isMonorepo ? "Monorepo detected \u2014 using mode: packages" : "Single-package repo detected \u2014 using mode: root"
+        );
+      } catch {
+        changelogMode = "root";
+        info("Could not detect project type \u2014 using mode: root");
+      }
+      let packageName;
+      try {
+        const pkg = JSON.parse(fs.readFileSync("package.json", "utf-8"));
+        packageName = pkg.name;
+      } catch {
+      }
+      const isScoped = packageName?.startsWith("@") ?? false;
+      const defaultConfig = {
+        $schema: "https://goosewobbler.github.io/releasekit/schema.json",
+        notes: {
+          changelog: {
+            mode: changelogMode
+          }
+        },
+        publish: {
+          npm: {
+            enabled: true,
+            ...isScoped ? { access: "public" } : {}
+          }
+        }
+      };
+      fs.writeFileSync(configPath, JSON.stringify(defaultConfig, null, 2), "utf-8");
+      success(`Created ${configPath}`);
+    }
+  });
+}
+
+// src/dispatcher.ts
 function createDispatcherProgram() {
-  const program = new Command().name("releasekit").description("Unified release pipeline: version, changelog, and publish").version(readPackageVersion(import.meta.url));
+  const program = new Command2().name("releasekit").description("Unified release pipeline: version, changelog, and publish").version(readPackageVersion(import.meta.url));
   program.addCommand(createReleaseCommand(), { isDefault: true });
+  program.addCommand(createInitCommand());
   program.addCommand(createVersionCommand());
   program.addCommand(createNotesCommand());
   program.addCommand(createPublishCommand());

package/dist/index.js

@@ -1,9 +1,9 @@
 import {
   runPreview
-} from "./chunk-J5NT6OX2.js";
+} from "./chunk-I5CGC253.js";
 import {
   runRelease
-} from "./chunk-I5ABZWVU.js";
+} from "./chunk-YZHGXRG6.js";
 export {
   runPreview,
   runRelease

package/docs/ci-setup.md

@@ -0,0 +1,266 @@
+# CI Setup
+
+This guide covers common GitHub Actions patterns for automating releases with `@releasekit/release`.
+
+## Prerequisites
+
+All workflows require:
+
+- `fetch-depth: 0` on checkout — ReleaseKit reads git history to determine version bumps
+- A `GITHUB_TOKEN` with `contents: write` permission for tagging and GitHub Releases
+- Node.js 20+
+
+---
+
+## Minimal Setup (push to main)
+
+Trigger a release on every push to `main`. If there are no releasable commits, the command exits cleanly with code 0 and does nothing.
+
+```yaml
+# .github/workflows/release.yml
+name: Release
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  id-token: write   # for npm OIDC trusted publishing
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - run: npm ci
+
+      - run: npx releasekit release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # For OIDC trusted publishing (recommended) — no NPM_TOKEN needed.
+          # For token-based publishing: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+```
+
+---
+
+## Label-Based Trigger
+
+Only release when a PR is merged with a release label. Conventional commits determine the changelog entries; the label controls whether and at what level to bump.
+
+**Required labels** (customisable in config):
+
+| Label | Effect |
+|-------|--------|
+| `release:patch` | Bump patch version |
+| `release:minor` | Bump minor version |
+| `release:major` | Bump major version |
+| `release:stable` | Graduate a prerelease to stable |
+| `release:prerelease` | Create a prerelease |
+| `release:skip` | Suppress release on this PR |
+
+```yaml
+# .github/workflows/release.yml
+name: Release
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  id-token: write
+  pull-requests: read
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - run: npm ci
+
+      - run: npx releasekit release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+Configure the trigger in `releasekit.config.json`:
+
+```json
+{
+  "ci": {
+    "releaseTrigger": "label",
+    "labels": {
+      "major": "release:major",
+      "minor": "release:minor",
+      "patch": "release:patch",
+      "skip": "release:skip"
+    }
+  }
+}
+```
+
+Without a `release:patch/minor/major` label on the merged PR, no release is triggered. The `labels` block shown above reflects the defaults — omit it if your repository already uses those label names.
+
+See [@releasekit/release — CI Configuration](../README.md#ci-configuration) for all `ci.*` options.
+
+---
+
+## PR Preview Comments
+
+Post a comment on every PR showing what would be released if merged. Requires `pull-requests: write`.
+
+```yaml
+# .github/workflows/release-preview.yml
+name: Release Preview
+
+on:
+  pull_request:
+    branches: [main]
+    types: [opened, synchronize, labeled, unlabeled]
+
+concurrency:
+  group: release-preview-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - run: npm ci
+
+      - run: npx releasekit preview
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+A ready-to-use template is available at [`templates/workflows/release-preview.yml`](../../../templates/workflows/release-preview.yml).
+
+---
+
+## npm OIDC Trusted Publishing (Recommended)
+
+With OIDC, no `NPM_TOKEN` secret is required. The workflow exchanges a GitHub-issued OIDC token for a short-lived npm token at publish time.
+
+**Requirements:**
+- npm `>=9.5.0`
+- Each package must have an **Automation policy** configured at npmjs.com (Settings → Automation policies → add a GitHub Actions OIDC publisher for your repo and workflow)
+
+**Important:** `actions/setup-node` with `registry-url` writes a project `.npmrc` that injects `_authToken=${NODE_AUTH_TOKEN}`. When `NODE_AUTH_TOKEN` is unset, npm resolves this to an empty token and fails with `ENEEDAUTH` instead of falling through to the OIDC exchange. Delete the file before publishing:
+
+```yaml
+permissions:
+  contents: write
+  id-token: write    # grants the OIDC token
+
+steps:
+  - uses: actions/setup-node@v4
+    with:
+      node-version: '20'
+      registry-url: 'https://registry.npmjs.org'
+
+  - run: npx releasekit release
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # No NPM_TOKEN needed with OIDC
+```
+
+ReleaseKit detects OIDC availability automatically (`npm-auth: auto`). To force it:
+
+```json
+{
+  "publish": {
+    "npm": { "auth": "oidc" }
+  }
+}
+```
+
+---
+
+## Prerelease Workflow
+
+```yaml
+# Manual dispatch for prereleases
+on:
+  workflow_dispatch:
+    inputs:
+      prerelease:
+        description: 'Prerelease identifier (e.g. beta, rc)'
+        required: true
+        default: 'beta'
+
+jobs:
+  prerelease:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - run: npm ci
+
+      - run: npx releasekit release --prerelease ${{ inputs.prerelease }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+---
+
+## Monorepo Targeted Release
+
+Release only specific packages:
+
+```bash
+npx releasekit release --target @myorg/core,@myorg/cli
+```
+
+Or version all packages together:
+
+```bash
+npx releasekit release --sync
+```
+
+---
+
+## Dry Run in CI
+
+Useful for verifying pipeline setup before enabling real releases:
+
+```yaml
+- run: npx releasekit release --dry-run --json
+```
+
+`--dry-run` prints what would happen without modifying any files, creating tags, or publishing packages. `--json` emits structured output for inspection.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@releasekit/release",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "description": "Unified release pipeline: version, changelog, and publish in a single command",
   "type": "module",
   "module": "./dist/index.js",
@@ -37,6 +37,7 @@
   "license": "MIT",
   "files": [
     "dist",
+    "docs",
     "README.md",
     "LICENSE"
   ],
@@ -49,9 +50,9 @@
     "commander": "^14.0.3",
     "smol-toml": "^1.6.1",
     "zod": "^4.3.6",
-    "@releasekit/notes": "0.3.1",
-    "@releasekit/version": "0.3.1",
-    "@releasekit/publish": "0.3.1"
+    "@releasekit/publish": "0.4.1",
+    "@releasekit/version": "0.4.1",
+    "@releasekit/notes": "0.4.1"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.4.6",