nx 17.2.6 → 17.2.7

package/changelog-renderer/index.d.ts

@@ -36,7 +36,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/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+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
@@ -44,12 +45,12 @@ const defaultChangelogRenderer = async ({ projectGraph, commits, releaseVersion,
         // 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) {
@@ -67,7 +68,7 @@ const defaultChangelogRenderer = async ({ projectGraph, commits, releaseVersion,
             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) {
                         const breakingChangeExplanation = extractBreakingChangeExplanation(commit.body);
@@ -85,11 +86,11 @@ const defaultChangelogRenderer = async ({ projectGraph, commits, releaseVersion,
         // 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}`, '');
+        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');
@@ -101,7 +102,7 @@ const defaultChangelogRenderer = async ({ projectGraph, commits, releaseVersion,
             markdownLines.push('', `### ${commitTypes[type].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) {
                     const breakingChangeExplanation = extractBreakingChangeExplanation(commit.body);
@@ -115,7 +116,7 @@ const defaultChangelogRenderer = async ({ projectGraph, commits, releaseVersion,
     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) {
@@ -190,12 +191,12 @@ function groupBy(items, key) {
     }
     return groups;
 }
-function formatCommit(commit, repoSlug) {
+function formatCommit(commit, changelogRenderOptions, repoSlug) {
     let commitLine = '- ' +
         (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;
@@ -221,3 +222,17 @@ function extractBreakingChangeExplanation(message) {
     // 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nx",
-  "version": "17.2.6",
+  "version": "17.2.7",
   "private": false,
   "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
   "repository": {
@@ -66,7 +66,7 @@
     "yargs": "^17.6.2",
     "yargs-parser": "21.1.1",
     "node-machine-id": "1.1.12",
-    "@nrwl/tao": "17.2.6"
+    "@nrwl/tao": "17.2.7"
   },
   "peerDependencies": {
     "@swc-node/register": "^1.6.7",
@@ -81,16 +81,16 @@
     }
   },
   "optionalDependencies": {
-    "@nx/nx-darwin-x64": "17.2.6",
-    "@nx/nx-darwin-arm64": "17.2.6",
-    "@nx/nx-linux-x64-gnu": "17.2.6",
-    "@nx/nx-linux-x64-musl": "17.2.6",
-    "@nx/nx-win32-x64-msvc": "17.2.6",
-    "@nx/nx-linux-arm64-gnu": "17.2.6",
-    "@nx/nx-linux-arm64-musl": "17.2.6",
-    "@nx/nx-linux-arm-gnueabihf": "17.2.6",
-    "@nx/nx-win32-arm64-msvc": "17.2.6",
-    "@nx/nx-freebsd-x64": "17.2.6"
+    "@nx/nx-darwin-x64": "17.2.7",
+    "@nx/nx-darwin-arm64": "17.2.7",
+    "@nx/nx-linux-x64-gnu": "17.2.7",
+    "@nx/nx-linux-x64-musl": "17.2.7",
+    "@nx/nx-win32-x64-msvc": "17.2.7",
+    "@nx/nx-linux-arm64-gnu": "17.2.7",
+    "@nx/nx-linux-arm64-musl": "17.2.7",
+    "@nx/nx-linux-arm-gnueabihf": "17.2.7",
+    "@nx/nx-win32-arm64-msvc": "17.2.7",
+    "@nx/nx-freebsd-x64": "17.2.7"
   },
   "nx-migrations": {
     "migrations": "./migrations.json",

package/src/command-line/release/changelog.js

@@ -227,15 +227,20 @@ function resolveChangelogRenderer(changelogRendererPath) {
 }
 async function generateChangelogForWorkspace(tree, args, projectGraph, nxReleaseConfig, workspaceChangelogVersion, commits, postGitTasks) {
     const config = nxReleaseConfig.changelog.workspaceChangelog;
+    const isEnabled = args.workspaceChangelog ?? config;
     // The entire feature is disabled at the workspace level, exit early
-    if (config === false) {
+    if (isEnabled === false) {
         return;
     }
     // If explicitly null it must mean that no changes were detected (e.g. when using conventional commits), so do nothing
     if (workspaceChangelogVersion === null) {
         return;
     }
-    if (!workspaceChangelogVersion) {
+    // The user explicitly passed workspaceChangelog=true but does not have a workspace changelog config in nx.json
+    if (!config) {
+        throw new Error(`Workspace changelog is enabled but no configuration was provided. Please provide a workspaceChangelog object in your nx.json`);
+    }
+    if (!workspaceChangelogVersion && args.workspaceChangelog) {
         throw new Error(`Workspace changelog is enabled but no overall version was provided. Please provide an explicit version using --version`);
     }
     // Only trigger interactive mode for the workspace changelog if the user explicitly requested it via "all" or "workspace"
@@ -270,9 +275,7 @@ async function generateChangelogForWorkspace(tree, args, projectGraph, nxRelease
     output_1.output.log({
         title: logTitle,
     });
-    const githubRepoSlug = config.createRelease === 'github'
-        ? (0, github_1.getGitHubRepoSlug)(gitRemote)
-        : undefined;
+    const githubRepoSlug = (0, github_1.getGitHubRepoSlug)(gitRemote);
     let contents = await changelogRenderer({
         projectGraph,
         commits,
@@ -565,7 +568,7 @@ async function generateChangelogForProjects(tree, args, projectGraph, commits, p
             if (!dryRun) {
                 postGitTasks.push(async (latestCommit) => {
                     // Before we can create/update the release we need to ensure the commit exists on the remote
-                    await (0, git_1.gitPush)();
+                    await (0, git_1.gitPush)(gitRemote);
                     await (0, github_1.createOrUpdateGithubRelease)(githubRequestConfig, {
                         version: releaseVersion.gitTag,
                         prerelease: releaseVersion.isPrerelease,

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

@@ -27,6 +27,7 @@ export type ChangelogOptions = NxReleaseArgs & GitCommitAndTagOptions & {
     from?: string;
     interactive?: string;
     gitRemote?: string;
+    workspaceChangelog?: boolean;
 };
 export type PublishOptions = NxReleaseArgs & Partial<RunManyOptions> & {
     outputStyle?: OutputStyle;
@@ -35,5 +36,9 @@ export type PublishOptions = NxReleaseArgs & Partial<RunManyOptions> & {
     tag?: string;
     otp?: number;
 };
+export type ReleaseOptions = NxReleaseArgs & {
+    yes?: boolean;
+    skipPublish?: boolean;
+};
 export declare const yargsReleaseCommand: CommandModule<Record<string, unknown>, NxReleaseArgs>;
 export {};

package/src/command-line/release/command-object.js

@@ -8,6 +8,7 @@ exports.yargsReleaseCommand = {
     command: 'release',
     describe: '**ALPHA**: Orchestrate versioning and publishing of applications and libraries',
     builder: (yargs) => yargs
+        .command(releaseCommand)
         .command(versionCommand)
         .command(changelogCommand)
         .command(publishCommand)
@@ -26,7 +27,7 @@ exports.yargsReleaseCommand = {
         coerce: shared_options_1.parseCSV,
         describe: 'Projects to run. (comma/space delimited project names and/or patterns)',
     })
-        .option('dryRun', {
+        .option('dry-run', {
         describe: 'Preview the changes without updating files/creating releases',
         alias: 'd',
         type: 'boolean',
@@ -55,6 +56,37 @@ exports.yargsReleaseCommand = {
         process.exit(1);
     },
 };
+const releaseCommand = {
+    command: '$0 [specifier]',
+    describe: 'Create a version and release for the workspace, generate a changelog, and optionally publish the packages',
+    builder: (yargs) => yargs
+        .positional('specifier', {
+        type: 'string',
+        describe: 'Exact version or semver keyword to apply to the selected release group.',
+    })
+        .option('yes', {
+        type: 'boolean',
+        alias: 'y',
+        description: 'Automatically answer yes to the confirmation prompt for publishing',
+    })
+        .option('skip-publish', {
+        type: 'boolean',
+        description: 'Skip publishing by automatically answering no to the confirmation prompt for publishing',
+    })
+        .check((argv) => {
+        if (argv.yes !== undefined && argv.skipPublish !== undefined) {
+            throw new Error('The --yes and --skip-publish options are mutually exclusive, please use one or the other.');
+        }
+        return true;
+    }),
+    handler: (args) => Promise.resolve().then(() => require('./release')).then((m) => m.releaseCLIHandler(args))
+        .then((versionDataOrExitCode) => {
+        if (typeof versionDataOrExitCode === 'number') {
+            return process.exit(versionDataOrExitCode);
+        }
+        process.exit(0);
+    }),
+};
 const versionCommand = {
     command: 'version [specifier]',
     aliases: ['v'],
@@ -108,7 +140,7 @@ const changelogCommand = {
         description: 'Interactively modify changelog markdown contents in your code editor before applying the changes. You can set it to be interactive for all changelogs, or only the workspace level, or only the project level',
         choices: ['all', 'workspace', 'projects'],
     })
-        .option('gitRemote', {
+        .option('git-remote', {
         type: 'string',
         description: 'Alternate git remote in the form {user}/{repo} on which to create the Github release (useful for testing)',
         default: 'origin',

package/src/command-line/release/config/config.js

@@ -47,7 +47,9 @@ requiredTargetName) {
                 file: '{workspaceRoot}/CHANGELOG.md',
                 renderer: 'nx/changelog-renderer',
                 renderOptions: {
-                    includeAuthors: true,
+                    authors: true,
+                    commitReferences: true,
+                    versionTitleDate: true,
                 },
             },
             // For projectChangelogs if the user has set any changelog config at all, then use one set of defaults, otherwise default to false for the whole feature
@@ -58,7 +60,9 @@ requiredTargetName) {
                     entryWhenNoChanges: 'This was a version bump only for {projectName} to align it with other projects, there were no code changes.',
                     renderer: 'nx/changelog-renderer',
                     renderOptions: {
-                        includeAuthors: true,
+                        authors: true,
+                        commitReferences: true,
+                        versionTitleDate: true,
                     },
                 }
                 : false,
@@ -82,7 +86,9 @@ requiredTargetName) {
             file: '{projectRoot}/CHANGELOG.md',
             renderer: 'nx/changelog-renderer',
             renderOptions: {
-                includeAuthors: true,
+                authors: true,
+                commitReferences: true,
+                versionTitleDate: true,
             },
         },
         releaseTagPattern: 

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

@@ -10,3 +10,7 @@ export { releasePublish } from './publish';
  * @public
  */
 export { releaseVersion } from './version';
+/**
+ * @public
+ */
+export { release } from './release';

package/src/command-line/release/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.releaseVersion = exports.releasePublish = exports.releaseChangelog = void 0;
+exports.release = exports.releaseVersion = exports.releasePublish = exports.releaseChangelog = void 0;
 /**
  * @public
  */
@@ -16,3 +16,8 @@ Object.defineProperty(exports, "releasePublish", { enumerable: true, get: functi
  */
 var version_1 = require("./version");
 Object.defineProperty(exports, "releaseVersion", { enumerable: true, get: function () { return version_1.releaseVersion; } });
+/**
+ * @public
+ */
+var release_1 = require("./release");
+Object.defineProperty(exports, "release", { enumerable: true, get: function () { return release_1.release; } });

package/src/command-line/release/publish.js

@@ -76,6 +76,11 @@ async function runPublishOnProjects(args, projectGraph, nxJson, projectNames) {
     }
     if (args.dryRun) {
         overrides.dryRun = args.dryRun;
+        /**
+         * Ensure the env var is set too, so that any and all publish executors triggered
+         * indirectly via dependsOn can also pick up on the fact that this is a dry run.
+         */
+        process.env.NX_DRY_RUN = 'true';
     }
     if (args.verbose) {
         process.env.NX_VERBOSE_LOGGING = 'true';

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

@@ -0,0 +1,4 @@
+import { ReleaseOptions, VersionOptions } from './command-object';
+import { NxReleaseVersionResult } from './version';
+export declare const releaseCLIHandler: (args: VersionOptions) => Promise<any>;
+export declare function release(args: ReleaseOptions): Promise<NxReleaseVersionResult | number>;

package/src/command-line/release/release.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.release = exports.releaseCLIHandler = void 0;
+const enquirer_1 = require("enquirer");
+const nx_json_1 = require("../../config/nx-json");
+const devkit_exports_1 = require("../../devkit-exports");
+const project_graph_1 = require("../../project-graph/project-graph");
+const params_1 = require("../../utils/params");
+const changelog_1 = require("./changelog");
+const config_1 = require("./config/config");
+const publish_1 = require("./publish");
+const resolve_nx_json_error_message_1 = require("./utils/resolve-nx-json-error-message");
+const version_1 = require("./version");
+const releaseCLIHandler = (args) => (0, params_1.handleErrors)(args.verbose, () => release(args));
+exports.releaseCLIHandler = releaseCLIHandler;
+async function release(args) {
+    const projectGraph = await (0, project_graph_1.createProjectGraphAsync)({ exitOnError: true });
+    const nxJson = (0, nx_json_1.readNxJson)();
+    if (args.verbose) {
+        process.env.NX_VERBOSE_LOGGING = 'true';
+    }
+    const hasVersionGitConfig = Object.keys(nxJson.release?.version?.git ?? {}).length > 0;
+    const hasChangelogGitConfig = Object.keys(nxJson.release?.changelog?.git ?? {}).length > 0;
+    if (hasVersionGitConfig || hasChangelogGitConfig) {
+        const jsonConfigErrorPath = hasVersionGitConfig
+            ? ['release', 'version', 'git']
+            : ['release', 'changelog', 'git'];
+        const nxJsonMessage = await (0, resolve_nx_json_error_message_1.resolveNxJsonConfigErrorMessage)(jsonConfigErrorPath);
+        devkit_exports_1.output.error({
+            title: `The 'release' top level command cannot be used with granular git configuration. Instead, configure git options in the 'release.git' property in nx.json.`,
+            bodyLines: [nxJsonMessage],
+        });
+        process.exit(1);
+    }
+    // Apply default configuration to any optional user configuration
+    const { error: configError, nxReleaseConfig } = await (0, config_1.createNxReleaseConfig)(projectGraph, nxJson.release, 'nx-release-publish');
+    if (configError) {
+        return await (0, config_1.handleNxReleaseConfigError)(configError);
+    }
+    const versionResult = await (0, version_1.releaseVersion)({
+        ...args,
+        // if enabled, committing and tagging will be handled by the changelog
+        // command, so we should only stage the changes in the version command
+        stageChanges: nxReleaseConfig.git?.commit,
+        gitCommit: false,
+        gitTag: false,
+    });
+    await (0, changelog_1.releaseChangelog)({
+        ...args,
+        versionData: versionResult.projectsVersionData,
+        version: versionResult.workspaceVersion,
+        workspaceChangelog: versionResult.workspaceVersion !== undefined,
+    });
+    let shouldPublish = !!args.yes && !args.skipPublish;
+    const shouldPromptPublishing = !args.yes && !args.skipPublish && !args.dryRun;
+    if (shouldPromptPublishing) {
+        shouldPublish = await promptForPublish();
+    }
+    if (shouldPublish) {
+        await (0, publish_1.releasePublish)(args);
+    }
+    else {
+        console.log('Skipped publishing packages.');
+    }
+    return versionResult;
+}
+exports.release = release;
+async function promptForPublish() {
+    console.log('\n');
+    const reply = await (0, enquirer_1.prompt)([
+        {
+            name: 'confirmation',
+            message: 'Do you want to publish these versions?',
+            type: 'confirm',
+        },
+    ]);
+    console.log('\n');
+    return reply.confirmation;
+}

package/src/command-line/release/utils/git.d.ts

@@ -48,7 +48,7 @@ export declare function gitTag({ tag, message, additionalArgs, dryRun, verbose,
     verbose?: boolean;
     logFn?: (message: string) => void;
 }): Promise<string>;
-export declare function gitPush(): Promise<void>;
+export declare function gitPush(gitRemote?: string): Promise<void>;
 export declare function parseCommits(commits: RawGitCommit[]): GitCommit[];
 export declare function parseGitCommit(commit: RawGitCommit): GitCommit | null;
 export declare function getCommitHash(ref: string): Promise<string>;

package/src/command-line/release/utils/git.js

@@ -155,7 +155,7 @@ async function gitTag({ tag, message, additionalArgs, dryRun, verbose, logFn, })
     }
 }
 exports.gitTag = gitTag;
-async function gitPush() {
+async function gitPush(gitRemote) {
     try {
         await (0, exec_command_1.execCommand)('git', [
             'push',
@@ -163,6 +163,8 @@ async function gitPush() {
             '--follow-tags',
             '--no-verify',
             '--atomic',
+            // Set custom git remote if provided
+            ...(gitRemote ? [gitRemote] : []),
         ]);
     }
     catch (err) {

package/src/command-line/release/utils/markdown.js

@@ -2,7 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseChangelogMarkdown = void 0;
 function parseChangelogMarkdown(contents) {
-    const CHANGELOG_RELEASE_HEAD_RE = new RegExp('^#{2,}\\s+(\\d+\\.\\d+\\.\\d+)', 'gm');
+    /**
+     * The release header may include prerelease identifiers (e.g., -alpha.13),
+     * and major releases may use a single #, instead of the standard ## used
+     * for minor and patch releases. This regex matches all of these cases.
+     */
+    const CHANGELOG_RELEASE_HEAD_RE = new RegExp('^#+\\s*\\[?(\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9\\.]+)?)\\]?', 'gm');
     const headings = [...contents.matchAll(CHANGELOG_RELEASE_HEAD_RE)];
     const releases = [];
     for (let i = 0; i < headings.length; i++) {

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

@@ -15,7 +15,7 @@ export interface ReleaseVersionGeneratorSchema {
     currentVersionResolver?: 'registry' | 'disk' | 'git-tag';
     currentVersionResolverMetadata?: Record<string, unknown>;
 }
-interface NxReleaseVersionResult {
+export interface NxReleaseVersionResult {
     /**
      * In one specific (and very common) case, an overall workspace version is relevant, for example when there is
      * only a single release group in which all projects have a fixed relationship to each other. In this case, the

package/src/config/nx-json.d.ts

@@ -47,7 +47,7 @@ export interface NxReleaseChangelogConfiguration {
      * is false by default.
      *
      * NOTE: if createRelease is set on a group of projects, it will cause the default releaseTagPattern of
-     * "{projectName}@v{version}" to be used for those projects, even when versioning everything together.
+     * "{projectName}@{version}" to be used for those projects, even when versioning everything together.
      */
     createRelease?: 'github' | false;
     /**
@@ -198,13 +198,13 @@ interface NxReleaseConfiguration {
     };
     /**
      * Optionally override the git/release tag pattern to use. This field is the source of truth
-     * for changelog generation and release tagging, as well as for conventional-commits parsing.
+     * for changelog generation and release tagging, as well as for conventional commits parsing.
      *
      * It supports interpolating the version as {version} and (if releasing independently or forcing
      * project level version control system releases) the project name as {projectName} within the string.
      *
-     * The default releaseTagPattern for unified releases is: "v{version}"
-     * The default releaseTagPattern for releases at the project level is: "{projectName}@v{version}"
+     * The default releaseTagPattern for fixed/unified releases is: "v{version}"
+     * The default releaseTagPattern for independent releases at the project level is: "{projectName}@{version}"
      */
     releaseTagPattern?: string;
     /**