nx 22.1.0-canary.20251110-73ecb30 → 22.1.0-canary.20251111-647d751

package/src/command-line/release/changelog/version-plan-filtering.js

@@ -0,0 +1,151 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterVersionPlansByCommitRange = filterVersionPlansByCommitRange;
+exports.resolveChangelogFromSHA = resolveChangelogFromSHA;
+exports.resolveWorkspaceChangelogFromSHA = resolveWorkspaceChangelogFromSHA;
+exports.extractPreidFromVersion = extractPreidFromVersion;
+exports.extractProjectsPreidFromVersionData = extractProjectsPreidFromVersionData;
+const path_1 = require("path");
+const semver_1 = require("semver");
+const workspace_root_1 = require("../../../utils/workspace-root");
+const exec_command_1 = require("../utils/exec-command");
+const git_1 = require("../utils/git");
+/**
+ * Filters version plans to only include those that were committed between the specified SHAs
+ * @param versionPlans The raw version plans to filter
+ * @param fromSHA The starting commit SHA (exclusive)
+ * @param toSHA The ending commit SHA (inclusive)
+ * @param isVerbose Whether to output verbose logging
+ * @returns The filtered version plans
+ */
+async function filterVersionPlansByCommitRange(versionPlans, fromSHA, toSHA, isVerbose) {
+    if (versionPlans.length === 0) {
+        return [];
+    }
+    // Get all files added within the commit range with a single git command
+    const filesAddedInRange = await getFilesAddedInCommitRange(fromSHA, toSHA, isVerbose);
+    // Filter version plans based on whether they were added in the range
+    const filteredPlans = versionPlans.filter((plan) => {
+        const isInRange = filesAddedInRange.has(plan.absolutePath);
+        if (!isInRange && isVerbose) {
+            console.log(`Filtering out version plan '${plan.fileName}' as it was not committed in the range ${fromSHA}..${toSHA}`);
+        }
+        else if (isInRange && isVerbose) {
+            console.log(`Version plan '${plan.fileName}' was added in commit range`);
+        }
+        return isInRange;
+    });
+    if (isVerbose) {
+        console.log(`Filtered ${versionPlans.length} version plans down to ${filteredPlans.length} based on commit range`);
+    }
+    return filteredPlans;
+}
+/**
+ * Gets all version plan files that were added within the commit range
+ * @param fromSHA The starting commit SHA (exclusive)
+ * @param toSHA The ending commit SHA (inclusive)
+ * @param isVerbose Whether to output verbose logging
+ * @returns Set of absolute file paths that were added in the range
+ */
+async function getFilesAddedInCommitRange(fromSHA, toSHA, isVerbose) {
+    try {
+        // Use git log to get version plan files added within the commit range
+        // --name-only shows just the file paths
+        // --diff-filter=A shows only added files
+        // -- .nx/version-plans/ limits to only files in that directory
+        // Note: Git pathspecs always use forward slashes, even on Windows
+        const stdout = await (0, exec_command_1.execCommand)('git', [
+            'log',
+            `${fromSHA}..${toSHA}`,
+            '--diff-filter=A',
+            '--name-only',
+            '--pretty=format:',
+            '--',
+            '.nx/version-plans/',
+        ]);
+        // Parse the output to get unique file paths
+        const files = stdout
+            .split('\n')
+            .filter((line) => line.trim().length > 0)
+            .map((relativePath) => {
+            // Convert relative paths to absolute paths
+            return (0, path_1.join)(workspace_root_1.workspaceRoot, relativePath);
+        });
+        const uniqueFiles = new Set(files);
+        if (isVerbose && uniqueFiles.size > 0) {
+            console.log(`Found ${uniqueFiles.size} version plan files added in commit range`);
+        }
+        return uniqueFiles;
+    }
+    catch (err) {
+        if (isVerbose) {
+            console.error(`Error getting files in commit range: ${err.message || err}`);
+        }
+        // If there's an error, return empty set (no filtering)
+        return new Set();
+    }
+}
+/**
+ * Resolves the "from SHA" for changelog purposes.
+ * This determines the starting point for changelog generation and optional version plan filtering.
+ */
+async function resolveChangelogFromSHA({ fromRef, tagPattern, tagPatternValues, checkAllBranchesWhen, preid, requireSemver, strictPreid, useAutomaticFromRef, }) {
+    // If user provided a from ref, resolve it to a SHA
+    if (fromRef) {
+        return await (0, git_1.getCommitHash)(fromRef);
+    }
+    // Otherwise, try to resolve it from the latest tag
+    const latestTag = await (0, git_1.getLatestGitTagForPattern)(tagPattern, tagPatternValues, {
+        checkAllBranchesWhen,
+        preid,
+        requireSemver,
+        strictPreid,
+    });
+    if (latestTag?.tag) {
+        return await (0, git_1.getCommitHash)(latestTag.tag);
+    }
+    // Finally, if automatic from ref is enabled, use the first commit as a fallback
+    if (useAutomaticFromRef) {
+        return await (0, git_1.getFirstGitCommit)();
+    }
+    return null;
+}
+/**
+ * Helper function for workspace-level "from SHA" resolution.
+ * Extracts preids and calls the generic resolver.
+ */
+async function resolveWorkspaceChangelogFromSHA({ args, nxReleaseConfig, useAutomaticFromRef, }) {
+    const workspacePreid = extractPreidFromVersion(args.version);
+    const projectsPreid = extractProjectsPreidFromVersionData(args.versionData);
+    return resolveChangelogFromSHA({
+        fromRef: args.from,
+        tagPattern: nxReleaseConfig.releaseTag.pattern,
+        tagPatternValues: {},
+        checkAllBranchesWhen: nxReleaseConfig.releaseTag.checkAllBranchesWhen,
+        preid: workspacePreid ?? projectsPreid?.[Object.keys(projectsPreid)[0]],
+        requireSemver: nxReleaseConfig.releaseTag.requireSemver,
+        strictPreid: nxReleaseConfig.releaseTag.strictPreid,
+        useAutomaticFromRef,
+    });
+}
+function extractPreidFromVersion(version) {
+    try {
+        const preid = (0, semver_1.prerelease)(version)?.[0];
+        return typeof preid === 'string' ? preid : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+function extractProjectsPreidFromVersionData(versionData) {
+    if (!versionData) {
+        return undefined;
+    }
+    const result = {};
+    for (const [project, data] of Object.entries(versionData)) {
+        if (data?.newVersion) {
+            result[project] = extractPreidFromVersion(data.newVersion);
+        }
+    }
+    return result;
+}

package/src/command-line/release/changelog/version-plan-utils.d.ts

@@ -0,0 +1,32 @@
+import { ReleaseType } from 'semver';
+import { GroupVersionPlan, ProjectsVersionPlan } from '../config/version-plans';
+import { RawGitCommit, Reference } from '../utils/git';
+export interface ChangelogChange {
+    type: string;
+    scope: string;
+    description: string;
+    affectedProjects: string[] | '*';
+    body?: string;
+    isBreaking?: boolean;
+    githubReferences?: Reference[];
+    authors?: {
+        name: string;
+        email: string;
+    }[];
+    shortHash?: string;
+    revertedHashes?: string[];
+}
+export declare function createChangesFromGroupVersionPlans(versionPlans: GroupVersionPlan[]): ChangelogChange[];
+export declare function createChangesFromProjectsVersionPlans(versionPlans: ProjectsVersionPlan[], projectName: string): ChangelogChange[];
+export declare function extractVersionPlanMetadata(commit: RawGitCommit | null): {
+    githubReferences: Reference[];
+    authors: {
+        name: string;
+        email: string;
+    }[] | undefined;
+};
+export declare function versionPlanSemverReleaseTypeToChangelogType(bump: ReleaseType): {
+    type: 'fix' | 'feat';
+    isBreaking: boolean;
+};
+//# sourceMappingURL=version-plan-utils.d.ts.map

package/src/command-line/release/changelog/version-plan-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version-plan-utils.d.ts","sourceRoot":"","sources":["../../../../../../../packages/nx/src/command-line/release/changelog/version-plan-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAChF,OAAO,EAAE,YAAY,EAA0B,SAAS,EAAE,MAAM,cAAc,CAAC;AAE/E,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,SAAS,EAAE,CAAC;IAC/B,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,wBAAgB,kCAAkC,CAChD,YAAY,EAAE,gBAAgB,EAAE,GAC/B,eAAe,EAAE,CAsCnB;AAED,wBAAgB,qCAAqC,CACnD,YAAY,EAAE,mBAAmB,EAAE,EACnC,WAAW,EAAE,MAAM,GAClB,eAAe,EAAE,CAyBnB;AAED,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,GAAG;IACvE,gBAAgB,EAAE,SAAS,EAAE,CAAC;IAC9B,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,SAAS,CAAC;CACxD,CAcA;AAED,wBAAgB,2CAA2C,CACzD,IAAI,EAAE,WAAW,GAChB;IACD,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;CACrB,CAeA"}

package/src/command-line/release/changelog/version-plan-utils.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createChangesFromGroupVersionPlans = createChangesFromGroupVersionPlans;
+exports.createChangesFromProjectsVersionPlans = createChangesFromProjectsVersionPlans;
+exports.extractVersionPlanMetadata = extractVersionPlanMetadata;
+exports.versionPlanSemverReleaseTypeToChangelogType = versionPlanSemverReleaseTypeToChangelogType;
+const git_1 = require("../utils/git");
+function createChangesFromGroupVersionPlans(versionPlans) {
+    return versionPlans
+        .flatMap((vp) => {
+        const releaseType = versionPlanSemverReleaseTypeToChangelogType(vp.groupVersionBump);
+        const { githubReferences, authors } = extractVersionPlanMetadata(vp.commit);
+        const changes = !vp.triggeredByProjects
+            ? [
+                {
+                    type: releaseType.type,
+                    scope: '',
+                    description: vp.message,
+                    body: '',
+                    isBreaking: releaseType.isBreaking,
+                    githubReferences,
+                    authors,
+                    affectedProjects: '*',
+                },
+            ]
+            : vp.triggeredByProjects.map((project) => {
+                return {
+                    type: releaseType.type,
+                    scope: project,
+                    description: vp.message,
+                    body: '',
+                    isBreaking: releaseType.isBreaking,
+                    githubReferences,
+                    authors,
+                    affectedProjects: [project],
+                };
+            });
+        return changes;
+    })
+        .filter(Boolean);
+}
+function createChangesFromProjectsVersionPlans(versionPlans, projectName) {
+    return versionPlans
+        .map((vp) => {
+        const bumpForProject = vp.projectVersionBumps[projectName];
+        if (!bumpForProject) {
+            return null;
+        }
+        const releaseType = versionPlanSemverReleaseTypeToChangelogType(bumpForProject);
+        const { githubReferences, authors } = extractVersionPlanMetadata(vp.commit);
+        return {
+            type: releaseType.type,
+            scope: projectName,
+            description: vp.message,
+            body: '',
+            isBreaking: releaseType.isBreaking,
+            affectedProjects: Object.keys(vp.projectVersionBumps),
+            githubReferences,
+            authors,
+        };
+    })
+        .filter(Boolean);
+}
+function extractVersionPlanMetadata(commit) {
+    if (!commit) {
+        return { githubReferences: [], authors: undefined };
+    }
+    const parsedCommit = (0, git_1.parseVersionPlanCommit)(commit);
+    if (!parsedCommit) {
+        return { githubReferences: [], authors: undefined };
+    }
+    return {
+        githubReferences: parsedCommit.references,
+        authors: parsedCommit.authors,
+    };
+}
+function versionPlanSemverReleaseTypeToChangelogType(bump) {
+    switch (bump) {
+        case 'premajor':
+        case 'major':
+            return { type: 'feat', isBreaking: true };
+        case 'preminor':
+        case 'minor':
+            return { type: 'feat', isBreaking: false };
+        case 'prerelease':
+        case 'prepatch':
+        case 'patch':
+            return { type: 'fix', isBreaking: false };
+        default:
+            throw new Error(`Invalid semver bump type: ${bump}`);
+    }
+}

package/src/command-line/release/changelog.d.ts

@@ -1,6 +1,5 @@
 import { NxReleaseConfiguration } from '../../config/nx-json';
 import { ChangelogOptions } from './command-object';
-import { Reference } from './utils/git';
 import { ReleaseVersion } from './utils/shared';
 export interface NxReleaseChangelogResult {
     workspaceChangelog?: {
@@ -16,21 +15,7 @@ export interface NxReleaseChangelogResult {
         };
     };
 }
-export interface ChangelogChange {
-    type: string;
-    scope: string;
-    description: string;
-    affectedProjects: string[] | '*';
-    body?: string;
-    isBreaking?: boolean;
-    githubReferences?: Reference[];
-    authors?: {
-        name: string;
-        email: string;
-    }[];
-    shortHash?: string;
-    revertedHashes?: string[];
-}
+export type { ChangelogChange } from './changelog/version-plan-utils';
 export type PostGitTask = (latestCommit: string) => Promise<void>;
 export declare const releaseChangelogCLIHandler: (args: ChangelogOptions) => Promise<number>;
 export declare function createAPI(overrideReleaseConfig: NxReleaseConfiguration, ignoreNxJsonConfig: boolean): (args: ChangelogOptions) => Promise<NxReleaseChangelogResult>;

package/src/command-line/release/changelog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"changelog.d.ts","sourceRoot":"","sources":["../../../../../../packages/nx/src/command-line/release/changelog.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,sBAAsB,EAAc,MAAM,sBAAsB,CAAC;AAkB1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAepD,OAAO,EAEL,SAAS,EAUV,MAAM,aAAa,CAAC;AASrB,OAAO,EACL,cAAc,EASf,MAAM,gBAAgB,CAAC;AAMxB,MAAM,WAAW,wBAAwB;IACvC,kBAAkB,CAAC,EAAE;QACnB,cAAc,EAAE,cAAc,CAAC;QAC/B,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;KACjC,CAAC;IACF,iBAAiB,CAAC,EAAE;QAClB,CAAC,WAAW,EAAE,MAAM,GAAG;YACrB,cAAc,EAAE,cAAc,CAAC;YAC/B,QAAQ,EAAE,MAAM,CAAC;YACjB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;SACjC,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,SAAS,EAAE,CAAC;IAC/B,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,MAAM,MAAM,WAAW,GAAG,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAElE,eAAO,MAAM,0BAA0B,GAAI,MAAM,gBAAgB,oBACH,CAAC;AAE/D,wBAAgB,SAAS,CACvB,qBAAqB,EAAE,sBAAsB,EAC7C,kBAAkB,EAAE,OAAO,IAQzB,MAAM,gBAAgB,KACrB,OAAO,CAAC,wBAAwB,CAAC,CA+pBrC"}
+{"version":3,"file":"changelog.d.ts","sourceRoot":"","sources":["../../../../../../packages/nx/src/command-line/release/changelog.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,sBAAsB,EAAc,MAAM,sBAAsB,CAAC;AAkB1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAmCpD,OAAO,EACL,cAAc,EASf,MAAM,gBAAgB,CAAC;AAsBxB,MAAM,WAAW,wBAAwB;IACvC,kBAAkB,CAAC,EAAE;QACnB,cAAc,EAAE,cAAc,CAAC;QAC/B,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;KACjC,CAAC;IACF,iBAAiB,CAAC,EAAE;QAClB,CAAC,WAAW,EAAE,MAAM,GAAG;YACrB,cAAc,EAAE,cAAc,CAAC;YAC/B,QAAQ,EAAE,MAAM,CAAC;YACjB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;SACjC,CAAC;KACH,CAAC;CACH;AAGD,YAAY,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEtE,MAAM,MAAM,WAAW,GAAG,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAElE,eAAO,MAAM,0BAA0B,GAAI,MAAM,gBAAgB,oBACH,CAAC;AAE/D,wBAAgB,SAAS,CACvB,qBAAqB,EAAE,sBAAsB,EAC7C,kBAAkB,EAAE,OAAO,IAQzB,MAAM,gBAAgB,KACrB,OAAO,CAAC,wBAAwB,CAAC,CAkhBrC"}