nx 17.0.3 → 17.0.4

package/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2017-2023 Narwhal Technologies Inc.
+Copyright (c) 2017-2024 Narwhal Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/README.md

@@ -1,4 +1,9 @@
-<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx.png" width="600" alt="Nx - Smart, Fast and Extensible Build System"></p>
+<p style="text-align: center;">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-dark.svg">
+    <img alt="Nx - Smart Monorepos · Fast CI" src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-light.svg" width="100%">
+  </picture>
+</p>
 
 <div style="text-align: center;">
 
@@ -15,9 +20,9 @@
 
 <hr>
 
-# Nx: Smart, Fast and Extensible Build System
+# Nx: Smart Monorepos · Fast CI
 
-Nx is a next generation build system with first class monorepo support and powerful integrations.
+Nx is a build system with built-in tooling and advanced CI capabilities. It helps you maintain and scale monorepos, both locally and on CI.
 
 ## Getting Started
 
@@ -57,5 +62,5 @@ npx nx@latest init
 - [Blog Posts About Nx](https://blog.nrwl.io/nx/home)
 
 <p style="text-align: center;"><a href="https://nx.dev/#learning-materials" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-courses-and-videos.svg" 
-width="100%" alt="Nx - Smart, Fast and Extensible Build System"></a></p>
+width="100%" alt="Nx - Smart Monorepos · Fast CI"></a></p>
 

package/bin/init-local.js

@@ -2,8 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.rewriteTargetsAndProjects = exports.initLocal = void 0;
 const perf_hooks_1 = require("perf_hooks");
-const child_process_1 = require("child_process");
-const package_manager_1 = require("../src/utils/package-manager");
 const nx_commands_1 = require("../src/command-line/nx-commands");
 const strip_indents_1 = require("../src/utils/strip-indents");
 const Mod = require("module");
@@ -39,8 +37,7 @@ function initLocal(workspace) {
             }
         }
         else {
-            const newArgs = rewritePositionalArguments(process.argv);
-            nx_commands_1.commandsObject.parse(newArgs);
+            nx_commands_1.commandsObject.parse(process.argv.slice(2));
         }
     }
     catch (e) {
@@ -80,38 +77,6 @@ function rewriteTargetsAndProjects(args) {
     return newArgs;
 }
 exports.rewriteTargetsAndProjects = rewriteTargetsAndProjects;
-function rewritePositionalArguments(args) {
-    const relevantPositionalArgs = [];
-    const rest = [];
-    for (let i = 2; i < args.length; i++) {
-        if (args[i] === '--') {
-            rest.push(...args.slice(i + 1));
-            break;
-        }
-        else if (!args[i].startsWith('-')) {
-            relevantPositionalArgs.push(args[i]);
-            if (relevantPositionalArgs.length === 2) {
-                rest.push(...args.slice(i + 1));
-                break;
-            }
-        }
-        else {
-            rest.push(args[i]);
-        }
-    }
-    if (relevantPositionalArgs.length === 1) {
-        return [
-            'run',
-            `${wrapIntoQuotesIfNeeded(relevantPositionalArgs[0])}`,
-            ...rest,
-        ];
-    }
-    return [
-        'run',
-        `${relevantPositionalArgs[1]}:${wrapIntoQuotesIfNeeded(relevantPositionalArgs[0])}`,
-        ...rest,
-    ];
-}
 function wrapIntoQuotesIfNeeded(arg) {
     return arg.indexOf(':') > -1 ? `"${arg}"` : arg;
 }
@@ -135,12 +100,12 @@ function isKnownCommand(command) {
 function shouldDelegateToAngularCLI() {
     const command = process.argv[2];
     const commands = [
-        'add',
         'analytics',
+        'cache',
+        'completion',
         'config',
         'doc',
         'update',
-        'completion',
     ];
     return commands.indexOf(command) > -1;
 }
@@ -157,36 +122,21 @@ function handleAngularCLIFallbacks(workspace) {
         console.log(`Running "ng update" can still be useful in some dev workflows, so we aren't planning to remove it.`);
         console.log(`If you need to use it, run "FORCE_NG_UPDATE=true ng update".`);
     }
-    else if (process.argv[2] === 'add') {
-        console.log('Ng add is not natively supported by Nx');
-        const pkg = process.argv[2] === 'add' ? process.argv[3] : process.argv[4];
-        if (!pkg) {
-            process.exit(1);
-        }
-        const pm = (0, package_manager_1.getPackageManagerCommand)();
-        const cmd = `${pm.add} ${pkg} && ${pm.exec} nx g ${pkg}:ng-add`;
-        console.log(`Instead, we recommend running \`${cmd}\``);
-        Promise.resolve().then(() => require('enquirer')).then((x) => x
-            .prompt({
-            name: 'c',
-            type: 'confirm',
-            message: 'Run this command?',
-        })
-            .then(({ c }) => {
-            if (c) {
-                (0, child_process_1.execSync)(cmd, { stdio: 'inherit' });
-            }
-        }));
-    }
     else if (process.argv[2] === 'completion') {
         if (!process.argv[3]) {
             console.log(`"ng completion" is not natively supported by Nx.
   Instead, you could try an Nx Editor Plugin for a visual tool to run Nx commands. If you're using VSCode, you can use the Nx Console plugin, or if you're using WebStorm, you could use one of the available community plugins.
-  For more information, see https://nx.dev/core-features/integrate-with-editors`);
+  For more information, see https://nx.dev/getting-started/editor-setup`);
         }
     }
+    else if (process.argv[2] === 'cache') {
+        console.log(`"ng cache" is not natively supported by Nx.
+To clear the cache, you can delete the ".angular/cache" directory (or the directory configured by "cli.cache.path" in the "nx.json" file).
+To update the cache configuration, you can directly update the relevant options in your "nx.json" file (https://angular.io/guide/workspace-config#cache-options).`);
+    }
     else {
         try {
+            // nx-ignore-next-line
             const cli = require.resolve('@angular/cli/lib/init.js', {
                 paths: [workspace.dir],
             });

package/bin/nx-cloud.js

@@ -35,6 +35,12 @@ async function invokeCommandWithNxCloudClient(options) {
     catch (e) {
         const body = ['Cannot run commands from the `nx-cloud` CLI.'];
         if (e instanceof update_manager_1.NxCloudEnterpriseOutdatedError) {
+            try {
+                // TODO: Remove this when all enterprise customers have updated.
+                // Try requiring the bin from the `nx-cloud` package.
+                return require('nx-cloud/bin/nx-cloud');
+            }
+            catch { }
             body.push('If you are an Nx Enterprise customer, please reach out to your assigned Developer Productivity Engineer.', 'If you are NOT an Nx Enterprise customer but are seeing this message, please reach out to cloud-support@nrwl.io.');
         }
         if (e instanceof update_manager_1.NxCloudClientUnavailableError) {

package/bin/nx.js

@@ -38,15 +38,6 @@ function main() {
         require('nx/src/command-line/nx-commands').commandsObject.argv;
     }
     else {
-        // v8-compile-cache doesn't support ESM. Attempting to import ESM
-        // with it enabled results in an error that reads "Invalid host options".
-        //
-        // Angular CLI, and prettier both use ESM so we need to disable it in these cases.
-        if (workspace &&
-            workspace.type === 'nx' &&
-            !['format', 'format:check', 'format:write', 'g', 'generate'].some((cmd) => process.argv[2] === cmd)) {
-            require('v8-compile-cache');
-        }
         if (!client_1.daemonClient.enabled() && workspace !== null) {
             (0, workspace_context_1.setupWorkspaceContext)(workspace.dir);
         }
@@ -156,6 +147,7 @@ function resolveNx(workspace) {
     catch {
         // TODO(v17): Remove this
         // fallback for old CLI install setup
+        // nx-ignore-next-line
         return require.resolve('@nrwl/cli/bin/nx.js', {
             paths: [workspace ? workspace.dir : globalsRoot],
         });

package/bin/post-install.js

@@ -10,8 +10,10 @@ const update_manager_1 = require("../src/nx-cloud/update-manager");
 const get_cloud_options_1 = require("../src/nx-cloud/utilities/get-cloud-options");
 const nx_cloud_utils_1 = require("../src/utils/nx-cloud-utils");
 const nx_json_1 = require("../src/config/nx-json");
+const workspace_context_1 = require("../src/utils/workspace-context");
 (async () => {
     try {
+        (0, workspace_context_1.setupWorkspaceContext)(workspace_root_1.workspaceRoot);
         if (isMainNxPackage() && (0, fileutils_1.fileExists)((0, path_1.join)(workspace_root_1.workspaceRoot, 'nx.json'))) {
             const b = new Date();
             (0, assert_supported_platform_1.assertSupportedPlatform)();
@@ -19,7 +21,9 @@ const nx_json_1 = require("../src/config/nx-json");
                 await client_1.daemonClient.stop();
             }
             catch (e) { }
-            const tasks = [(0, project_graph_1.buildProjectGraphWithoutDaemon)()];
+            const tasks = [
+                (0, project_graph_1.buildProjectGraphAndSourceMapsWithoutDaemon)(),
+            ];
             if ((0, nx_cloud_utils_1.isNxCloudUsed)((0, nx_json_1.readNxJson)())) {
                 tasks.push((0, update_manager_1.verifyOrUpdateNxCloudClient)((0, get_cloud_options_1.getCloudOptions)()));
             }

package/bin/run-executor.js

@@ -60,7 +60,7 @@ process.on('message', async (message) => {
         process.exit(statusCode);
     }
     catch (e) {
-        console.error(`Could not find 'nx' module in this workspace.`, e);
+        console.error(e);
         process.exit(1);
     }
 });

package/migrations.json

@@ -76,6 +76,24 @@
       "version": "17.0.0-rc.1",
       "description": "Migration for v17.0.0-rc.1",
       "implementation": "./src/migrations/update-17-0-0/rm-default-collection-npm-scope"
+    },
+    "17.3.0-update-nx-wrapper": {
+      "cli": "nx",
+      "version": "17.3.0-beta.6",
+      "description": "Updates the nx wrapper.",
+      "implementation": "./src/migrations/update-17-3-0/update-nxw"
+    },
+    "18.0.0-disable-adding-plugins-for-existing-workspaces": {
+      "cli": "nx",
+      "version": "18.0.0-beta.2",
+      "description": "Updates nx.json to disabled adding plugins when generating projects in an existing Nx workspace",
+      "implementation": "./src/migrations/update-18-0-0/disable-crystal-for-existing-workspaces",
+      "x-repair-skip": true
+    },
+    "move-default-base-to-nx-json-root": {
+      "version": "18.1.0-beta.3",
+      "description": "Moves affected.defaultBase to defaultBase in `nx.json`",
+      "implementation": "./src/migrations/update-17-2-0/move-default-base"
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nx",
-  "version": "17.0.3",
+  "version": "17.0.4",
   "private": false,
   "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
   "repository": {
@@ -36,7 +36,7 @@
     "@yarnpkg/lockfile": "^1.1.0",
     "@yarnpkg/parsers": "3.0.0-rc.46",
     "@zkochan/js-yaml": "0.0.6",
-    "axios": "^1.5.1",
+    "axios": "^1.6.0",
     "chalk": "^4.1.0",
     "cli-cursor": "3.1.0",
     "cli-spinners": "2.6.1",
@@ -47,30 +47,29 @@
     "figures": "3.2.0",
     "flat": "^5.0.2",
     "fs-extra": "^11.1.0",
-    "glob": "7.1.4",
     "ignore": "^5.0.4",
     "jest-diff": "^29.4.1",
     "js-yaml": "4.1.0",
     "jsonc-parser": "3.2.0",
     "lines-and-columns": "~2.0.3",
-    "minimatch": "3.0.5",
+    "minimatch": "9.0.3",
     "npm-run-path": "^4.0.1",
     "open": "^8.4.0",
-    "semver": "7.5.3",
+    "semver": "^7.5.3",
     "string-width": "^4.2.3",
     "strong-log-transformer": "^2.1.0",
     "tar-stream": "~2.2.0",
     "tmp": "~0.2.1",
     "tsconfig-paths": "^4.1.2",
     "tslib": "^2.3.0",
-    "v8-compile-cache": "2.3.0",
     "yargs": "^17.6.2",
     "yargs-parser": "21.1.1",
     "node-machine-id": "1.1.12",
-    "@nrwl/tao": "17.0.3"
+    "ora": "5.3.0",
+    "@nrwl/tao": "17.0.4"
   },
   "peerDependencies": {
-    "@swc-node/register": "^1.6.7",
+    "@swc-node/register": "^1.8.0",
     "@swc/core": "^1.3.85"
   },
   "peerDependenciesMeta": {
@@ -82,16 +81,16 @@
     }
   },
   "optionalDependencies": {
-    "@nx/nx-darwin-x64": "17.0.3",
-    "@nx/nx-darwin-arm64": "17.0.3",
-    "@nx/nx-linux-x64-gnu": "17.0.3",
-    "@nx/nx-linux-x64-musl": "17.0.3",
-    "@nx/nx-win32-x64-msvc": "17.0.3",
-    "@nx/nx-linux-arm64-gnu": "17.0.3",
-    "@nx/nx-linux-arm64-musl": "17.0.3",
-    "@nx/nx-linux-arm-gnueabihf": "17.0.3",
-    "@nx/nx-win32-arm64-msvc": "17.0.3",
-    "@nx/nx-freebsd-x64": "17.0.3"
+    "@nx/nx-darwin-x64": "17.0.4",
+    "@nx/nx-darwin-arm64": "17.0.4",
+    "@nx/nx-linux-x64-gnu": "17.0.4",
+    "@nx/nx-linux-x64-musl": "17.0.4",
+    "@nx/nx-win32-x64-msvc": "17.0.4",
+    "@nx/nx-linux-arm64-gnu": "17.0.4",
+    "@nx/nx-linux-arm64-musl": "17.0.4",
+    "@nx/nx-linux-arm-gnueabihf": "17.0.4",
+    "@nx/nx-win32-arm64-msvc": "17.0.4",
+    "@nx/nx-freebsd-x64": "17.0.4"
   },
   "nx-migrations": {
     "migrations": "./migrations.json",
@@ -121,12 +120,14 @@
       "@nrwl/expo",
       "@nx/express",
       "@nrwl/express",
+      "@nx/gradle",
       "@nx/nest",
       "@nrwl/nest",
       "@nx/next",
       "@nrwl/next",
       "@nx/node",
       "@nrwl/node",
+      "@nx/nuxt",
       "@nx/playwright",
       "@nx/plugin",
       "@nrwl/nx-plugin",
@@ -136,6 +137,8 @@
       "@nrwl/react-native",
       "@nx/rollup",
       "@nrwl/rollup",
+      "@nx/remix",
+      "@nrwl/remix",
       "@nx/storybook",
       "@nrwl/storybook",
       "@nrwl/tao",

package/plugins/package-json.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const workspace_root_1 = require("../src/utils/workspace-root");
-const package_json_workspaces_1 = require("./package-json-workspaces");
+const package_json_workspaces_1 = require("../src/plugins/package-json-workspaces");
 const plugin = {
     name: 'nx-all-package-jsons-plugin',
     createNodes: [

package/{changelog-renderer → release/changelog-renderer}/index.d.ts

@@ -1,5 +1,7 @@
-import type { GitCommit } from '../src/command-line/release/utils/git';
-import { RepoSlug } from '../src/command-line/release/utils/github';
+import { NxReleaseConfig } from '../../src/command-line/release/config/config';
+import type { GitCommit } from '../../src/command-line/release/utils/git';
+import { RepoSlug } from '../../src/command-line/release/utils/github';
+import type { ProjectGraph } from '../../src/config/project-graph';
 /**
  * The ChangelogRenderOptions are specific to each ChangelogRenderer implementation, and are taken
  * from the user's nx.json configuration and passed as is into the ChangelogRenderer function.
@@ -10,6 +12,7 @@ export type ChangelogRenderOptions = Record<string, unknown>;
  * and returns a string, or a Promise of a string of changelog contents (usually markdown).
  *
  * @param {Object} config The configuration object for the ChangelogRenderer
+ * @param {ProjectGraph} config.projectGraph The project graph for the workspace
  * @param {GitCommit[]} config.commits The collection of extracted commits to generate a changelog for
  * @param {string} config.releaseVersion The version that is being released
  * @param {string | null} config.project The name of specific project to generate a changelog for, or `null` if the overall workspace changelog
@@ -17,12 +20,14 @@ export type ChangelogRenderOptions = Record<string, unknown>;
  * @param {ChangelogRenderOptions} config.changelogRenderOptions The options specific to the ChangelogRenderer implementation
  */
 export type ChangelogRenderer = (config: {
+    projectGraph: ProjectGraph;
     commits: GitCommit[];
     releaseVersion: string;
     project: string | null;
     entryWhenNoChanges: string | false;
     changelogRenderOptions: DefaultChangelogRenderOptions;
     repoSlug?: RepoSlug;
+    conventionalCommitsConfig: NxReleaseConfig['conventionalCommits'];
 }) => Promise<string> | string;
 /**
  * The specific options available to the default implementation of the ChangelogRenderer that nx exports
@@ -33,7 +38,17 @@ export interface DefaultChangelogRenderOptions extends ChangelogRenderOptions {
      * Whether or not the commit authors should be added to the bottom of the changelog in a "Thank You"
      * section. Defaults to true.
      */
-    includeAuthors?: boolean;
+    authors?: boolean;
+    /**
+     * Whether or not the commit references (such as commit and/or PR links) should be included in the changelog.
+     * Defaults to true.
+     */
+    commitReferences?: boolean;
+    /**
+     * Whether or not to include the date in the version title. It can be set to false to disable it, or true to enable
+     * with the default of (YYYY-MM-DD). Defaults to true.
+     */
+    versionTitleDate?: boolean;
 }
 /**
  * The default ChangelogRenderer implementation that nx exports for the common case of generating markdown

package/{changelog-renderer → release/changelog-renderer}/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const github_1 = require("../src/command-line/release/utils/github");
+const semver_1 = require("semver");
+const github_1 = require("../../src/command-line/release/utils/github");
+const shared_1 = require("../../src/command-line/release/utils/shared");
 // axios types and values don't seem to match
 const _axios = require("axios");
 const axios = _axios;
@@ -8,40 +10,39 @@ const axios = _axios;
  * The default ChangelogRenderer implementation that nx exports for the common case of generating markdown
  * from the given commits and other metadata.
  */
-const defaultChangelogRenderer = async ({ commits, releaseVersion, project, entryWhenNoChanges, changelogRenderOptions, repoSlug, }) => {
+const defaultChangelogRenderer = async ({ projectGraph, commits, releaseVersion, project, entryWhenNoChanges, changelogRenderOptions, repoSlug, conventionalCommitsConfig, }) => {
+    const commitTypes = conventionalCommitsConfig.types;
     const markdownLines = [];
     const breakingChanges = [];
-    const commitTypes = {
-        feat: { title: '🚀 Features' },
-        perf: { title: '🔥 Performance' },
-        fix: { title: '🩹 Fixes' },
-        refactor: { title: '💅 Refactors' },
-        docs: { title: '📖 Documentation' },
-        build: { title: '📦 Build' },
-        types: { title: '🌊 Types' },
-        chore: { title: '🏡 Chore' },
-        examples: { title: '🏀 Examples' },
-        test: { title: '✅ Tests' },
-        style: { title: '🎨 Styles' },
-        ci: { title: '🤖 CI' },
-    };
+    // If the current range of commits contains both a commit and its revert, we strip them both from the final list
+    for (const commit of commits) {
+        if (commit.type === 'revert') {
+            for (const revertedHash of commit.revertedHashes) {
+                const revertedCommit = commits.find((c) => revertedHash.startsWith(c.shortHash));
+                if (revertedCommit) {
+                    commits.splice(commits.indexOf(revertedCommit), 1);
+                    commits.splice(commits.indexOf(commit), 1);
+                }
+            }
+        }
+    }
     // workspace root level changelog
     if (project === null) {
         // No changes for the workspace
         if (commits.length === 0) {
             if (entryWhenNoChanges) {
-                markdownLines.push('', `## ${releaseVersion}\n\n${entryWhenNoChanges}`, '');
+                markdownLines.push('', `${createVersionTitle(releaseVersion, changelogRenderOptions)}\n\n${entryWhenNoChanges}`, '');
             }
             return markdownLines.join('\n').trim();
         }
         const typeGroups = groupBy(commits, 'type');
-        markdownLines.push('', `## ${releaseVersion}`, '');
+        markdownLines.push('', createVersionTitle(releaseVersion, changelogRenderOptions), '');
         for (const type of Object.keys(commitTypes)) {
             const group = typeGroups[type];
             if (!group || group.length === 0) {
                 continue;
             }
-            markdownLines.push('', '### ' + commitTypes[type].title, '');
+            markdownLines.push('', '### ' + commitTypes[type].changelog.title, '');
             /**
              * In order to make the final changelog most readable, we organize commits as follows:
              * - By scope, where scopes are in alphabetical order (commits with no scope are listed first)
@@ -53,10 +54,13 @@ const defaultChangelogRenderer = async ({ commits, releaseVersion, project, entr
             for (const scope of scopesSortedAlphabetically) {
                 const commits = commitsGroupedByScope[scope];
                 for (const commit of commits) {
-                    const line = formatCommit(commit, repoSlug);
+                    const line = formatCommit(commit, changelogRenderOptions, repoSlug);
                     markdownLines.push(line);
                     if (commit.isBreaking) {
-                        breakingChanges.push(line);
+                        const breakingChangeExplanation = extractBreakingChangeExplanation(commit.body);
+                        breakingChanges.push(breakingChangeExplanation
+                            ? `- ${commit.scope ? `**${commit.scope.trim()}:** ` : ''}${breakingChangeExplanation}`
+                            : line);
                     }
                 }
             }
@@ -64,28 +68,33 @@ const defaultChangelogRenderer = async ({ commits, releaseVersion, project, entr
     }
     else {
         // project level changelog
-        const scopeGroups = groupBy(commits, 'scope');
-        // Generating for a named project, but that project has no changes in the current set of commits, exit early
-        if (!scopeGroups[project]) {
+        const relevantCommits = await (0, shared_1.getCommitsRelevantToProjects)(projectGraph, commits, [project]);
+        // Generating for a named project, but that project has no relevant changes in the current set of commits, exit early
+        if (relevantCommits.length === 0) {
             if (entryWhenNoChanges) {
-                markdownLines.push('', `## ${releaseVersion}\n\n${entryWhenNoChanges}`, '');
+                markdownLines.push('', `${createVersionTitle(releaseVersion, changelogRenderOptions)}\n\n${entryWhenNoChanges}`, '');
             }
             return markdownLines.join('\n').trim();
         }
-        markdownLines.push('', `## ${releaseVersion}`, '');
-        const typeGroups = groupBy(scopeGroups[project], 'type');
+        markdownLines.push('', createVersionTitle(releaseVersion, changelogRenderOptions), '');
+        const typeGroups = groupBy(
+        // Sort the relevant commits to have the unscoped commits first, before grouping by type
+        relevantCommits.sort((a, b) => (b.scope ? 1 : 0) - (a.scope ? 1 : 0)), 'type');
         for (const type of Object.keys(commitTypes)) {
             const group = typeGroups[type];
             if (!group || group.length === 0) {
                 continue;
             }
-            markdownLines.push('', `### ${commitTypes[type].title}`, '');
+            markdownLines.push('', `### ${commitTypes[type].changelog.title}`, '');
             const commitsInChronologicalOrder = group.reverse();
             for (const commit of commitsInChronologicalOrder) {
-                const line = formatCommit(commit, repoSlug);
+                const line = formatCommit(commit, changelogRenderOptions, repoSlug);
                 markdownLines.push(line + '\n');
                 if (commit.isBreaking) {
-                    breakingChanges.push(line);
+                    const breakingChangeExplanation = extractBreakingChangeExplanation(commit.body);
+                    breakingChanges.push(breakingChangeExplanation
+                        ? `- ${commit.scope ? `**${commit.scope.trim()}:** ` : ''}${breakingChangeExplanation}`
+                        : line);
                 }
             }
         }
@@ -93,7 +102,7 @@ const defaultChangelogRenderer = async ({ commits, releaseVersion, project, entr
     if (breakingChanges.length > 0) {
         markdownLines.push('', '#### ⚠️  Breaking Changes', '', ...breakingChanges);
     }
-    if (changelogRenderOptions.includeAuthors) {
+    if (changelogRenderOptions.authors) {
         const _authors = new Map();
         for (const commit of commits) {
             if (!commit.author) {
@@ -168,13 +177,48 @@ function groupBy(items, key) {
     }
     return groups;
 }
-function formatCommit(commit, repoSlug) {
+function formatCommit(commit, changelogRenderOptions, repoSlug) {
     let commitLine = '- ' +
-        (commit.scope ? `**${commit.scope.trim()}:** ` : '') +
         (commit.isBreaking ? '⚠️  ' : '') +
+        (commit.scope ? `**${commit.scope.trim()}:** ` : '') +
         commit.description;
-    if (repoSlug) {
+    if (repoSlug && changelogRenderOptions.commitReferences) {
         commitLine += (0, github_1.formatReferences)(commit.references, repoSlug);
     }
     return commitLine;
 }
+/**
+ * It is common to add further information about a breaking change in the commit body,
+ * and it is naturally that information that should be included in the BREAKING CHANGES
+ * section of changelog, rather than repeating the commit title/description.
+ */
+function extractBreakingChangeExplanation(message) {
+    const breakingChangeIdentifier = 'BREAKING CHANGE:';
+    const startIndex = message.indexOf(breakingChangeIdentifier);
+    if (startIndex === -1) {
+        // "BREAKING CHANGE:" not found in the message
+        return null;
+    }
+    const startOfBreakingChange = startIndex + breakingChangeIdentifier.length;
+    const endOfBreakingChange = message.indexOf('\n', startOfBreakingChange);
+    if (endOfBreakingChange === -1) {
+        // No newline character found, extract till the end of the message
+        return message.substring(startOfBreakingChange).trim();
+    }
+    // Extract and return the breaking change message
+    return message.substring(startOfBreakingChange, endOfBreakingChange).trim();
+}
+function createVersionTitle(version, changelogRenderOptions) {
+    // Normalize by removing any leading `v` during comparison
+    const isMajorVersion = `${(0, semver_1.major)(version)}.0.0` === version.replace(/^v/, '');
+    let maybeDateStr = '';
+    if (changelogRenderOptions.versionTitleDate) {
+        // YYYY-MM-DD
+        const dateStr = new Date().toISOString().slice(0, 10);
+        maybeDateStr = ` (${dateStr})`;
+    }
+    if (isMajorVersion) {
+        return `# ${version}${maybeDateStr}`;
+    }
+    return `## ${version}${maybeDateStr}`;
+}

package/release/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @public Programmatic API for nx release
+ */
+export { release, releaseChangelog, releasePublish, releaseVersion, } from '../src/command-line/release';

package/release/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.releaseVersion = exports.releasePublish = exports.releaseChangelog = exports.release = void 0;
+/**
+ * @public Programmatic API for nx release
+ */
+var release_1 = require("../src/command-line/release");
+Object.defineProperty(exports, "release", { enumerable: true, get: function () { return release_1.release; } });
+Object.defineProperty(exports, "releaseChangelog", { enumerable: true, get: function () { return release_1.releaseChangelog; } });
+Object.defineProperty(exports, "releasePublish", { enumerable: true, get: function () { return release_1.releasePublish; } });
+Object.defineProperty(exports, "releaseVersion", { enumerable: true, get: function () { return release_1.releaseVersion; } });