@exadev/semantic-release-workspace 1.1.7 → 1.2.1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { AnalyzeCommitsContext, BranchSpec, GenerateNotesContext } from "semantic-release";
+import { AnalyzeCommitsContext, BranchSpec, Commit, GenerateNotesContext } from "semantic-release";
 //#region src/package-name.d.ts
 declare const packageName = "@exadev/semantic-release-workspace";
 //#endregion
@@ -144,6 +144,8 @@ interface DependencyBumpSource {
 type PublishPluginSpec = string | readonly [string] | readonly [string, Record<string, unknown>];
 /** The standard publish pipeline this orchestrator coordinates when a workspace configures none of its own. Every entry reuses the corresponding official plugin -- the orchestrator scopes and sequences them per package, it does not reimplement npm publishing, GitHub release creation, or changelog writing. */
 declare const DEFAULT_PUBLISH_PLUGINS: readonly PublishPluginSpec[];
+/** The standard publish pipeline for `commitStrategy: 'single'`: the same as `DEFAULT_PUBLISH_PLUGINS` minus @semantic-release/git, which that mode never runs -- see `resolvePublishPlugins`'s `forbidGitPlugin` option for why it is rejected outright rather than merely unused. Single-commit mode does its own committing (one combined commit for every released package), so a `prepare`-step git plugin here would create the very per-package commits that mode exists to avoid. */
+declare const SINGLE_COMMIT_DEFAULT_PUBLISH_PLUGINS: readonly PublishPluginSpec[];
 interface ScopedPlugins {
   readonly analyzeCommits: (pluginConfig: Record<string, unknown>, context: AnalyzeCommitsContext & {
     cwd: string;
@@ -164,6 +166,8 @@ declare function createScopedPlugins(scope: {
   readonly analyzeCommitsConfig: Record<string, unknown>;
   readonly generateNotesConfig: Record<string, unknown>;
   readonly bumps: DependencyBumpSource;
+  /** Called with the path-filtered commit list every time this package's commits are resolved (from either step, whichever runs first). Optional: `commitStrategy: 'single'` uses it to capture the same filtered list `success()`'s GitHub plugin step needs later, without recomputing `changedPathsSince`/`filterCommitsToDirectory` itself from the outside. */
+  readonly onCommitsResolved?: (commits: readonly Commit[]) => void;
 }): ScopedPlugins;
 /**
  * Keeps a commit for the package when any path it changed lies under the package's directory. The trailing-slash prefix comparison stops `packages/a` from matching `packages/abc/x`.
@@ -177,9 +181,17 @@ declare function filterCommitsToDirectory<T extends {
 type ResolvedPublishPlugin = [string, Record<string, unknown>];
 declare function resolvePublishPlugins(specs: readonly PublishPluginSpec[], workspaceRoot: string, options: {
   readonly requireGitPlugin: boolean;
+  readonly forbidGitPlugin?: boolean;
 }): readonly ResolvedPublishPlugin[];
 //#endregion
 //#region src/release.d.ts
+/**
+ * How a run commits its released changes:
+ *
+ * - `'per-package'` (the default): today's behaviour, unchanged. Each package's own semantic-release run commits, tags, and pushes itself the moment it releases, and each cross-package dependency bump is its own immediately-pushed commit. This is the byte-for-byte pre-existing behaviour of this package and stays the default so no existing consumer's release history changes shape without opting in.
+ * - `'single'`: every package's version bump, changelog, and dependency-range rewrite for the whole run is folded into one combined commit, tagged once per released package (all tags pointing at that one commit), pushed once. Publish-pipeline steps (npm, GitHub) still run per package afterward, scoped to the already-committed-and-tagged state. See `single-commit-release.ts` for the full design.
+ */
+type CommitStrategy = 'per-package' | 'single';
 interface ReleaseWorkspaceOptions {
   /** Directory holding the workspace's `pnpm-workspace.yaml`. Defaults to the process working directory. */
   readonly root?: string;
@@ -189,7 +201,7 @@ interface ReleaseWorkspaceOptions {
   readonly dryRun?: boolean;
   /** Release branch configuration for semantic-release. Defaults to semantic-release's own default branch list. */
   readonly branches?: readonly BranchSpec[];
-  /** Publish-pipeline plugins (changelog, npm, GitHub, git), each scoped per package by semantic-release's own `cwd`. Defaults to the standard pipeline in DEFAULT_PUBLISH_PLUGINS. */
+  /** Publish-pipeline plugins (changelog, npm, GitHub, git), each scoped per package by semantic-release's own `cwd`. Defaults to the standard pipeline in DEFAULT_PUBLISH_PLUGINS for `commitStrategy: 'per-package'`, or SINGLE_COMMIT_DEFAULT_PUBLISH_PLUGINS (the same list minus @semantic-release/git) for `commitStrategy: 'single'`. */
   readonly plugins?: readonly PublishPluginSpec[];
   /** Options for the wrapped @semantic-release/commit-analyzer, applied per package after path filtering. */
   readonly analyzeCommits?: Record<string, unknown>;
@@ -197,6 +209,8 @@ interface ReleaseWorkspaceOptions {
   readonly generateNotes?: Record<string, unknown>;
   /** Progress sink for the orchestrator's own narration (semantic-release logs its own detail). Defaults to `console.log`. */
   readonly log?: (message: string) => void;
+  /** How the run commits its released changes. Defaults to `'per-package'`, today's exact existing behaviour. See `CommitStrategy` for what each mode does. */
+  readonly commitStrategy?: CommitStrategy;
 }
 /** One dependency-range change applied to a dependent package's manifest during the run, attached to the dependent's own outcome. */
 interface AppliedDependencyBump extends DependencyBump {
@@ -256,4 +270,4 @@ declare class GitCommandError extends WorkspaceReleaseError {
 /** The workspace's git state does not support the release operation -- for example a detached HEAD, which names no branch that dependency-bump commits could be pushed to. */
 declare class WorkspaceStateError extends WorkspaceReleaseError {}
 //#endregion
-export { type AppliedDependencyBump, DEFAULT_PUBLISH_PLUGINS, type DependencyBump, type DependencyBumpSource, DependencyCycleError, type DependencyField, type DependencyGraph, type DependencyRangeShape, type DependencyRangeUpdate, GitCommandError, type PackageManifest, type PackageReleaseOutcome, type PublishPluginSpec, ReleaseConfigurationError, type ReleaseWorkspaceOptions, type ResolvedPublishPlugin, type ScopedPlugins, UnsupportedDependencyRangeError, type Workspace, type WorkspaceDependency, WorkspaceDiscoveryError, type WorkspacePackage, WorkspaceReleaseError, type WorkspaceReleaseOutcome, WorkspaceStateError, buildDependencyGraph, classifyDependencyRange, createScopedPlugins, discoverWorkspace, filterCommitsToDirectory, packageName, readManifest, releaseWorkspace, resolvePublishPlugins, topologicalOrder, updateDependencyRange, writeDependencyRange };
+export { type AppliedDependencyBump, type CommitStrategy, DEFAULT_PUBLISH_PLUGINS, type DependencyBump, type DependencyBumpSource, DependencyCycleError, type DependencyField, type DependencyGraph, type DependencyRangeShape, type DependencyRangeUpdate, GitCommandError, type PackageManifest, type PackageReleaseOutcome, type PublishPluginSpec, ReleaseConfigurationError, type ReleaseWorkspaceOptions, type ResolvedPublishPlugin, SINGLE_COMMIT_DEFAULT_PUBLISH_PLUGINS, type ScopedPlugins, UnsupportedDependencyRangeError, type Workspace, type WorkspaceDependency, WorkspaceDiscoveryError, type WorkspacePackage, WorkspaceReleaseError, type WorkspaceReleaseOutcome, WorkspaceStateError, buildDependencyGraph, classifyDependencyRange, createScopedPlugins, discoverWorkspace, filterCommitsToDirectory, packageName, readManifest, releaseWorkspace, resolvePublishPlugins, topologicalOrder, updateDependencyRange, writeDependencyRange };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AnalyzeCommitsContext, BranchSpec, GenerateNotesContext } from "semantic-release";
+import { AnalyzeCommitsContext, BranchSpec, Commit, GenerateNotesContext } from "semantic-release";
 //#region src/package-name.d.ts
 declare const packageName = "@exadev/semantic-release-workspace";
 //#endregion
@@ -144,6 +144,8 @@ interface DependencyBumpSource {
 type PublishPluginSpec = string | readonly [string] | readonly [string, Record<string, unknown>];
 /** The standard publish pipeline this orchestrator coordinates when a workspace configures none of its own. Every entry reuses the corresponding official plugin -- the orchestrator scopes and sequences them per package, it does not reimplement npm publishing, GitHub release creation, or changelog writing. */
 declare const DEFAULT_PUBLISH_PLUGINS: readonly PublishPluginSpec[];
+/** The standard publish pipeline for `commitStrategy: 'single'`: the same as `DEFAULT_PUBLISH_PLUGINS` minus @semantic-release/git, which that mode never runs -- see `resolvePublishPlugins`'s `forbidGitPlugin` option for why it is rejected outright rather than merely unused. Single-commit mode does its own committing (one combined commit for every released package), so a `prepare`-step git plugin here would create the very per-package commits that mode exists to avoid. */
+declare const SINGLE_COMMIT_DEFAULT_PUBLISH_PLUGINS: readonly PublishPluginSpec[];
 interface ScopedPlugins {
   readonly analyzeCommits: (pluginConfig: Record<string, unknown>, context: AnalyzeCommitsContext & {
     cwd: string;
@@ -164,6 +166,8 @@ declare function createScopedPlugins(scope: {
   readonly analyzeCommitsConfig: Record<string, unknown>;
   readonly generateNotesConfig: Record<string, unknown>;
   readonly bumps: DependencyBumpSource;
+  /** Called with the path-filtered commit list every time this package's commits are resolved (from either step, whichever runs first). Optional: `commitStrategy: 'single'` uses it to capture the same filtered list `success()`'s GitHub plugin step needs later, without recomputing `changedPathsSince`/`filterCommitsToDirectory` itself from the outside. */
+  readonly onCommitsResolved?: (commits: readonly Commit[]) => void;
 }): ScopedPlugins;
 /**
  * Keeps a commit for the package when any path it changed lies under the package's directory. The trailing-slash prefix comparison stops `packages/a` from matching `packages/abc/x`.
@@ -177,9 +181,17 @@ declare function filterCommitsToDirectory<T extends {
 type ResolvedPublishPlugin = [string, Record<string, unknown>];
 declare function resolvePublishPlugins(specs: readonly PublishPluginSpec[], workspaceRoot: string, options: {
   readonly requireGitPlugin: boolean;
+  readonly forbidGitPlugin?: boolean;
 }): readonly ResolvedPublishPlugin[];
 //#endregion
 //#region src/release.d.ts
+/**
+ * How a run commits its released changes:
+ *
+ * - `'per-package'` (the default): today's behaviour, unchanged. Each package's own semantic-release run commits, tags, and pushes itself the moment it releases, and each cross-package dependency bump is its own immediately-pushed commit. This is the byte-for-byte pre-existing behaviour of this package and stays the default so no existing consumer's release history changes shape without opting in.
+ * - `'single'`: every package's version bump, changelog, and dependency-range rewrite for the whole run is folded into one combined commit, tagged once per released package (all tags pointing at that one commit), pushed once. Publish-pipeline steps (npm, GitHub) still run per package afterward, scoped to the already-committed-and-tagged state. See `single-commit-release.ts` for the full design.
+ */
+type CommitStrategy = 'per-package' | 'single';
 interface ReleaseWorkspaceOptions {
   /** Directory holding the workspace's `pnpm-workspace.yaml`. Defaults to the process working directory. */
   readonly root?: string;
@@ -189,7 +201,7 @@ interface ReleaseWorkspaceOptions {
   readonly dryRun?: boolean;
   /** Release branch configuration for semantic-release. Defaults to semantic-release's own default branch list. */
   readonly branches?: readonly BranchSpec[];
-  /** Publish-pipeline plugins (changelog, npm, GitHub, git), each scoped per package by semantic-release's own `cwd`. Defaults to the standard pipeline in DEFAULT_PUBLISH_PLUGINS. */
+  /** Publish-pipeline plugins (changelog, npm, GitHub, git), each scoped per package by semantic-release's own `cwd`. Defaults to the standard pipeline in DEFAULT_PUBLISH_PLUGINS for `commitStrategy: 'per-package'`, or SINGLE_COMMIT_DEFAULT_PUBLISH_PLUGINS (the same list minus @semantic-release/git) for `commitStrategy: 'single'`. */
   readonly plugins?: readonly PublishPluginSpec[];
   /** Options for the wrapped @semantic-release/commit-analyzer, applied per package after path filtering. */
   readonly analyzeCommits?: Record<string, unknown>;
@@ -197,6 +209,8 @@ interface ReleaseWorkspaceOptions {
   readonly generateNotes?: Record<string, unknown>;
   /** Progress sink for the orchestrator's own narration (semantic-release logs its own detail). Defaults to `console.log`. */
   readonly log?: (message: string) => void;
+  /** How the run commits its released changes. Defaults to `'per-package'`, today's exact existing behaviour. See `CommitStrategy` for what each mode does. */
+  readonly commitStrategy?: CommitStrategy;
 }
 /** One dependency-range change applied to a dependent package's manifest during the run, attached to the dependent's own outcome. */
 interface AppliedDependencyBump extends DependencyBump {
@@ -256,4 +270,4 @@ declare class GitCommandError extends WorkspaceReleaseError {
 /** The workspace's git state does not support the release operation -- for example a detached HEAD, which names no branch that dependency-bump commits could be pushed to. */
 declare class WorkspaceStateError extends WorkspaceReleaseError {}
 //#endregion
-export { type AppliedDependencyBump, DEFAULT_PUBLISH_PLUGINS, type DependencyBump, type DependencyBumpSource, DependencyCycleError, type DependencyField, type DependencyGraph, type DependencyRangeShape, type DependencyRangeUpdate, GitCommandError, type PackageManifest, type PackageReleaseOutcome, type PublishPluginSpec, ReleaseConfigurationError, type ReleaseWorkspaceOptions, type ResolvedPublishPlugin, type ScopedPlugins, UnsupportedDependencyRangeError, type Workspace, type WorkspaceDependency, WorkspaceDiscoveryError, type WorkspacePackage, WorkspaceReleaseError, type WorkspaceReleaseOutcome, WorkspaceStateError, buildDependencyGraph, classifyDependencyRange, createScopedPlugins, discoverWorkspace, filterCommitsToDirectory, packageName, readManifest, releaseWorkspace, resolvePublishPlugins, topologicalOrder, updateDependencyRange, writeDependencyRange };
+export { type AppliedDependencyBump, type CommitStrategy, DEFAULT_PUBLISH_PLUGINS, type DependencyBump, type DependencyBumpSource, DependencyCycleError, type DependencyField, type DependencyGraph, type DependencyRangeShape, type DependencyRangeUpdate, GitCommandError, type PackageManifest, type PackageReleaseOutcome, type PublishPluginSpec, ReleaseConfigurationError, type ReleaseWorkspaceOptions, type ResolvedPublishPlugin, SINGLE_COMMIT_DEFAULT_PUBLISH_PLUGINS, type ScopedPlugins, UnsupportedDependencyRangeError, type Workspace, type WorkspaceDependency, WorkspaceDiscoveryError, type WorkspacePackage, WorkspaceReleaseError, type WorkspaceReleaseOutcome, WorkspaceStateError, buildDependencyGraph, classifyDependencyRange, createScopedPlugins, discoverWorkspace, filterCommitsToDirectory, packageName, readManifest, releaseWorkspace, resolvePublishPlugins, topologicalOrder, updateDependencyRange, writeDependencyRange };