@pnpm/releasing.versioning 1100.2.6 → 1100.3.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @pnpm/releasing.versioning
 
+## 1100.3.0
+
+### Minor Changes
+
+- Added `pnpm change check`. It validates the committed package versions against the `versioning.epics` bands and the `versioning.fixed` groups in `pnpm-workspace.yaml` and lists every violation. It is meant to run in CI, because `pnpm version -r` only checks the packages it releases.
+
+### Patch Changes
+
+- Updated dependencies:
+  - @pnpm/error@1100.1.4
+  - @pnpm/workspace.project-manifest-reader@1100.0.27
+
+## 1100.2.7
+
+### Patch Changes
+
+- Updated dependencies:
+  - @pnpm/types@1102.1.0
+  - @pnpm/workspace.project-manifest-reader@1100.0.26
+
 ## 1100.2.6
 
 ### Patch Changes

package/lib/assembleReleasePlan.d.ts

@@ -90,6 +90,28 @@ export declare function indexProjectRefs(projects: ReadonlyArray<{
 /** The workspace-relative directory of a project, in canonical spelling. */
 export declare function toProjectDir(workspaceDir: string, rootDir: string): string;
 export declare function assembleReleasePlan(opts: AssembleReleasePlanOptions): ReleasePlan;
+export interface VersioningInvariantViolation {
+    code: 'VERSIONING_EPIC_OUT_OF_BAND' | 'VERSIONING_FIXED_GROUP_MISMATCH';
+    message: string;
+}
+export interface CheckVersioningInvariantsOptions {
+    workspaceDir: string;
+    projects: WorkspaceProject[];
+    versioning?: VersioningSettings;
+}
+/**
+ * Validates that the committed versions already satisfy the invariants the
+ * configuration declares: every epic member's major sits inside its lead's
+ * band, and every fixed group shares one version. This is the static
+ * counterpart to the release-time enforcement in `assembleReleasePlan`, which
+ * only checks packages a plan actually releases — so a committed manifest that
+ * drifted out of band, or a fixed group that fell out of lockstep, would
+ * otherwise go unnoticed until a release that happens to touch it. Returns
+ * every violation so a caller can report them all at once; malformed
+ * configuration (unknown lead, epic overlap, a group straddling an epic) still
+ * throws, exactly as plan assembly would.
+ */
+export declare function checkVersioningInvariants(opts: CheckVersioningInvariantsOptions): VersioningInvariantViolation[];
 /**
  * The range that pnpm materializes for a workspace: spec at pack time, given
  * the dependency's version at the dependent's previous release. Dependent

package/lib/assembleReleasePlan.js

@@ -72,6 +72,55 @@ export function assembleReleasePlan(opts) {
         selection = expanded;
     }
 }
+/**
+ * Validates that the committed versions already satisfy the invariants the
+ * configuration declares: every epic member's major sits inside its lead's
+ * band, and every fixed group shares one version. This is the static
+ * counterpart to the release-time enforcement in `assembleReleasePlan`, which
+ * only checks packages a plan actually releases — so a committed manifest that
+ * drifted out of band, or a fixed group that fell out of lockstep, would
+ * otherwise go unnoticed until a release that happens to touch it. Returns
+ * every violation so a caller can report them all at once; malformed
+ * configuration (unknown lead, epic overlap, a group straddling an epic) still
+ * throws, exactly as plan assembly would.
+ */
+export function checkVersioningInvariants(opts) {
+    const refs = indexProjectRefs(opts.projects, opts.workspaceDir);
+    const participants = collectParticipants(opts.projects, refs, opts);
+    const lanesByDir = resolveLanes(refs, participants, opts.versioning);
+    const fixedGroups = resolveFixedGroups(refs, participants, opts.versioning);
+    validateFixedGroupLanes(fixedGroups, lanesByDir, opts.versioning);
+    const epics = resolveEpics(refs, participants, opts.versioning);
+    validateEpics(epics, fixedGroups);
+    // With no plan (no new versions), the band derives from the lead's current
+    // major, and members are checked against their current versions.
+    const noNewVersions = new Map();
+    const violations = [];
+    for (const epic of epics) {
+        const band = epicBand(epic, participants, noNewVersions);
+        for (const memberDir of [...epic.memberDirs].sort()) {
+            const member = participants.get(memberDir);
+            const memberMajor = Number(member.currentVersion.split('.')[0]);
+            if (!band.contains(memberMajor)) {
+                violations.push({
+                    code: 'VERSIONING_EPIC_OUT_OF_BAND',
+                    message: `${member.name} is at ${member.currentVersion}, whose major ${memberMajor} is outside the band ${band.low}-${band.high} of the epic led by "${epic.leadRef}" (major ${band.major}).`,
+                });
+            }
+        }
+    }
+    for (const [index, group] of fixedGroups.entries()) {
+        const members = group.map((dir) => participants.get(dir));
+        if (new Set(members.map((member) => member.currentVersion)).size > 1) {
+            const detail = members.map((member) => `${member.name}@${member.currentVersion}`).join(', ');
+            violations.push({
+                code: 'VERSIONING_FIXED_GROUP_MISMATCH',
+                message: `The fixed group [${(opts.versioning?.fixed ?? [])[index].join(', ')}] is not in lockstep: ${detail}.`,
+            });
+        }
+    }
+    return violations;
+}
 function assemble(ctx, selection) {
     const { participants, lanesByDir, fixedGroups, epics, opts } = ctx;
     const pendingByDir = collectPendingIntents(ctx);
@@ -603,9 +652,13 @@ function epicRebaseFloor(epic, participants, newVersions) {
     if (lead == null || newLeadVersion == null || parsePrerelease(newLeadVersion) != null)
         return null;
     const newMajor = Number(newLeadVersion.split('.')[0]);
-    const currentMajor = Number(lead.currentVersion.split('.')[0]);
+    const currentMajor = epicLeadBandMajor(lead.currentVersion);
     return newMajor > currentMajor ? newMajor * 100 : null;
 }
+function epicLeadBandMajor(version) {
+    const [major, minor, patch] = stablePart(version).split('.').map(Number);
+    return parsePrerelease(version) != null && minor === 0 && patch === 0 ? Math.max(0, major - 1) : major;
+}
 /**
  * Overrides the computed version of every bumped epic member with the band
  * floor when its lead crosses to a new stable major. A member on a lane
@@ -627,15 +680,12 @@ function applyEpicBandVersions({ participants, state, newVersions, epics, lanesB
         }
     }
 }
-/**
- * The band of member majors an epic permits: `[leadMajor×100, leadMajor×100+99]`,
- * where `leadMajor` is the major the plan establishes for the lead — its
- * re-based major when the lead crosses to a new stable major, otherwise the
- * lead's current major (a prerelease lead does not open the next band).
- */
-function epicBandMajor(epic, participants, newVersions) {
+function epicBand(epic, participants, newVersions) {
     const floor = epicRebaseFloor(epic, participants, newVersions);
-    return floor != null ? floor / 100 : Number(participants.get(epic.leadDir).currentVersion.split('.')[0]);
+    const major = floor != null ? floor / 100 : epicLeadBandMajor(participants.get(epic.leadDir).currentVersion);
+    const low = major * 100;
+    const high = low + 99;
+    return { major, low, high, contains: (memberMajor) => memberMajor >= low && memberMajor <= high };
 }
 /**
  * Enforces that every released member's new major stays inside its epic's band.
@@ -646,17 +696,15 @@ function epicBandMajor(epic, participants, newVersions) {
  */
 function enforceEpicBands(epics, participants, newVersions) {
     for (const epic of epics) {
-        const bandMajor = epicBandMajor(epic, participants, newVersions);
-        const low = bandMajor * 100;
-        const high = low + 99;
+        const band = epicBand(epic, participants, newVersions);
         for (const memberDir of epic.memberDirs) {
             const memberVersion = newVersions.get(memberDir);
             if (memberVersion == null)
                 continue;
             const memberMajor = Number(memberVersion.split('.')[0]);
-            if (memberMajor < low || memberMajor > high) {
-                throw new PnpmError('VERSIONING_EPIC_OUT_OF_BAND', `The release plan takes ${participants.get(memberDir).name} to ${memberVersion}, whose major ${memberMajor} is outside the band ${low}-${high} of the epic led by "${epic.leadRef}" (major ${bandMajor}). ` +
-                    (memberMajor > high
+            if (!band.contains(memberMajor)) {
+                throw new PnpmError('VERSIONING_EPIC_OUT_OF_BAND', `The release plan takes ${participants.get(memberDir).name} to ${memberVersion}, whose major ${memberMajor} is outside the band ${band.low}-${band.high} of the epic led by "${epic.leadRef}" (major ${band.major}). ` +
+                    (memberMajor > band.high
                         ? 'The band is exhausted - the lead must advance to a new major to open the next band.'
                         : 'Re-base the member into the band, or remove it from the epic.'));
             }

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 export { type AppliedRelease, applyReleasePlan, type ApplyReleasePlanOptions, changelogStorage, } from './applyReleasePlan.js';
-export { assembleReleasePlan, type AssembleReleasePlanOptions, type DependencyUpdate, indexProjectRefs, isDirRef, materializeWorkspaceRange, type PlannedRelease, type ProjectRefIndex, type ReleaseCause, type ReleasePlan, toProjectDir, type WorkspaceProject, } from './assembleReleasePlan.js';
+export { assembleReleasePlan, type AssembleReleasePlanOptions, checkVersioningInvariants, type CheckVersioningInvariantsOptions, type DependencyUpdate, indexProjectRefs, isDirRef, materializeWorkspaceRange, type PlannedRelease, type ProjectRefIndex, type ReleaseCause, type ReleasePlan, toProjectDir, type VersioningInvariantViolation, type WorkspaceProject, } from './assembleReleasePlan.js';
 export { composeChangelogSection, prependChangelogSection, renderChangelog, } from './changelog.js';
 export { BUMP_TYPES, type ChangeIntent, CHANGES_DIR, type IntentBumpType, parseChangeIntent, readChangeIntents, type ReleaseBumpType, writeChangeIntent, type WriteChangeIntentOptions, } from './intents.js';
 export { appendToLedger, buildConsumptionIndex, type Ledger, LEDGER_FILENAME, type LedgerEntry, ledgerEntryIds, normalizeProjectDir, type PackageConsumption, readLedger, } from './ledger.js';

package/lib/index.js

@@ -1,5 +1,5 @@
 export { applyReleasePlan, changelogStorage, } from './applyReleasePlan.js';
-export { assembleReleasePlan, indexProjectRefs, isDirRef, materializeWorkspaceRange, toProjectDir, } from './assembleReleasePlan.js';
+export { assembleReleasePlan, checkVersioningInvariants, indexProjectRefs, isDirRef, materializeWorkspaceRange, toProjectDir, } from './assembleReleasePlan.js';
 export { composeChangelogSection, prependChangelogSection, renderChangelog, } from './changelog.js';
 export { BUMP_TYPES, CHANGES_DIR, parseChangeIntent, readChangeIntents, writeChangeIntent, } from './intents.js';
 export { appendToLedger, buildConsumptionIndex, LEDGER_FILENAME, ledgerEntryIds, normalizeProjectDir, readLedger, } from './ledger.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/releasing.versioning",
-  "version": "1100.2.6",
+  "version": "1100.3.0",
   "description": "Native workspace release management: change intents, release-plan assembly, and changelog writing",
   "keywords": [
     "pnpm",
@@ -27,9 +27,9 @@
     "!*.map"
   ],
   "dependencies": {
-    "@pnpm/error": "1100.1.3",
-    "@pnpm/types": "1102.0.0",
-    "@pnpm/workspace.project-manifest-reader": "1100.0.25",
+    "@pnpm/error": "1100.1.4",
+    "@pnpm/types": "1102.1.0",
+    "@pnpm/workspace.project-manifest-reader": "1100.0.27",
     "@pnpm/workspace.spec-parser": "1100.0.1",
     "human-id": "^4.2.1",
     "semver": "^7.8.5",
@@ -37,7 +37,7 @@
   },
   "devDependencies": {
     "@jest/globals": "30.4.1",
-    "@pnpm/releasing.versioning": "1100.2.6",
+    "@pnpm/releasing.versioning": "1100.3.0",
     "@types/semver": "7.8.0",
     "tempy": "3.0.0"
   },