nx 21.0.0-beta.0 → 21.0.0-beta.2

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

@@ -13,14 +13,15 @@ const tree_1 = require("../../generators/tree");
 const file_map_utils_1 = require("../../project-graph/file-map-utils");
 const project_graph_1 = require("../../project-graph/project-graph");
 const utils_1 = require("../../tasks-runner/utils");
+const handle_errors_1 = require("../../utils/handle-errors");
 const is_ci_1 = require("../../utils/is-ci");
 const output_1 = require("../../utils/output");
-const handle_errors_1 = require("../../utils/handle-errors");
 const path_1 = require("../../utils/path");
 const workspace_root_1 = require("../../utils/workspace-root");
 const config_1 = require("./config/config");
 const deep_merge_json_1 = require("./config/deep-merge-json");
 const filter_release_groups_1 = require("./config/filter-release-groups");
+const use_legacy_versioning_1 = require("./config/use-legacy-versioning");
 const version_plans_1 = require("./config/version-plans");
 const git_1 = require("./utils/git");
 const github_1 = require("./utils/github");
@@ -46,7 +47,8 @@ function createAPI(overrideReleaseConfig) {
         // Apply default configuration to any optional user configuration
         const { error: configError, nxReleaseConfig } = await (0, config_1.createNxReleaseConfig)(projectGraph, await (0, file_map_utils_1.createProjectFileMapUsingProjectGraph)(projectGraph), userProvidedReleaseConfig);
         if (configError) {
-            return await (0, config_1.handleNxReleaseConfigError)(configError);
+            const USE_LEGACY_VERSIONING = (0, use_legacy_versioning_1.shouldUseLegacyVersioning)(userProvidedReleaseConfig);
+            return await (0, config_1.handleNxReleaseConfigError)(configError, USE_LEGACY_VERSIONING);
         }
         // --print-config exits directly as it is not designed to be combined with any other programmatic operations
         if (args.printConfig) {
@@ -137,7 +139,7 @@ function createAPI(overrideReleaseConfig) {
         (0, shared_1.handleDuplicateGitTags)(gitTagValues);
         const postGitTasks = [];
         let workspaceChangelogChanges = [];
-        // TODO: remove this after the changelog renderer is refactored to remove coupling with git commits
+        // TODO(v22): remove this after the changelog renderer is refactored to remove coupling with git commits
         let workspaceChangelogCommits = [];
         // If there are multiple release groups, we'll just skip the workspace changelog anyway.
         const versionPlansEnabledForWorkspaceChangelog = releaseGroups[0].resolvedVersionPlans;
@@ -191,8 +193,7 @@ function createAPI(overrideReleaseConfig) {
         }
         else {
             let workspaceChangelogFromRef = args.from ||
-                (await (0, git_1.getLatestGitTagForPattern)(nxReleaseConfig.releaseTagPattern))
-                    ?.tag;
+                (await (0, git_1.getLatestGitTagForPattern)(nxReleaseConfig.releaseTagPattern, {}, nxReleaseConfig.releaseTagPatternCheckAllBranchesWhen))?.tag;
             if (!workspaceChangelogFromRef) {
                 if (useAutomaticFromRef) {
                     workspaceChangelogFromRef = await (0, git_1.getFirstGitCommit)();
@@ -229,7 +230,7 @@ function createAPI(overrideReleaseConfig) {
             nxReleaseConfig,
             workspaceChangelogVersion,
             changes: workspaceChangelogChanges,
-            // TODO: remove this after the changelog renderer is refactored to remove coupling with git commits
+            // TODO(v22): remove this after the changelog renderer is refactored to remove coupling with git commits
             commits: filterHiddenCommits(workspaceChangelogCommits, nxReleaseConfig.conventionalCommits),
         });
         if (workspaceChangelog &&
@@ -260,7 +261,7 @@ function createAPI(overrideReleaseConfig) {
                     .map((dep) => {
                     return {
                         dependencyName: dep.source,
-                        newVersion: projectsVersionData[dep.source].newVersion,
+                        newVersion: projectsVersionData[dep.source]?.newVersion ?? null,
                     };
                 })
                     .filter((b) => b.newVersion !== null);
@@ -297,7 +298,7 @@ function createAPI(overrideReleaseConfig) {
             if (releaseGroup.projectsRelationship === 'independent') {
                 for (const project of projectNodes) {
                     let changes = null;
-                    // TODO: remove this after the changelog renderer is refactored to remove coupling with git commits
+                    // TODO(v22): remove this after the changelog renderer is refactored to remove coupling with git commits
                     let commits;
                     if (releaseGroup.resolvedVersionPlans) {
                         changes = releaseGroup.resolvedVersionPlans
@@ -335,7 +336,7 @@ function createAPI(overrideReleaseConfig) {
                             (await (0, git_1.getLatestGitTagForPattern)(releaseGroup.releaseTagPattern, {
                                 projectName: project.name,
                                 releaseGroupName: releaseGroup.name,
-                            }))?.tag;
+                            }, releaseGroup.releaseTagPatternCheckAllBranchesWhen))?.tag;
                         if (!fromRef && useAutomaticFromRef) {
                             const firstCommit = await (0, git_1.getFirstGitCommit)();
                             const allCommits = await getCommits(firstCommit, toSHA);
@@ -396,7 +397,7 @@ function createAPI(overrideReleaseConfig) {
             }
             else {
                 let changes = [];
-                // TODO: remove this after the changelog renderer is refactored to remove coupling with git commits
+                // TODO(v22): remove this after the changelog renderer is refactored to remove coupling with git commits
                 let commits = [];
                 if (releaseGroup.resolvedVersionPlans) {
                     changes = releaseGroup.resolvedVersionPlans
@@ -442,8 +443,7 @@ function createAPI(overrideReleaseConfig) {
                 }
                 else {
                     let fromRef = args.from ||
-                        (await (0, git_1.getLatestGitTagForPattern)(releaseGroup.releaseTagPattern))
-                            ?.tag;
+                        (await (0, git_1.getLatestGitTagForPattern)(releaseGroup.releaseTagPattern, {}, releaseGroup.releaseTagPatternCheckAllBranchesWhen))?.tag;
                     if (!fromRef) {
                         if (useAutomaticFromRef) {
                             fromRef = await (0, git_1.getFirstGitCommit)();
@@ -644,11 +644,12 @@ async function applyChangesAndExit(args, nxReleaseConfig, tree, toSHA, postGitTa
         }
     }
     if (args.gitPush ?? nxReleaseConfig.changelog.git.push) {
-        output_1.output.logSingleLine(`Pushing to git remote "${args.gitRemote}"`);
+        output_1.output.logSingleLine(`Pushing to git remote "${args.gitRemote ?? 'origin'}"`);
         await (0, git_1.gitPush)({
             gitRemote: args.gitRemote,
             dryRun: args.dryRun,
             verbose: args.verbose,
+            additionalArgs: args.gitPushArgs || nxReleaseConfig.changelog.git.pushArgs,
         });
     }
     // Run any post-git tasks in series
@@ -902,7 +903,7 @@ function filterHiddenChanges(changes, conventionalCommitsConfig) {
         return !typeConfig.changelog.hidden;
     });
 }
-// TODO: remove this after the changelog renderer is refactored to remove coupling with git commits
+// TODO(v22): remove this after the changelog renderer is refactored to remove coupling with git commits
 function filterHiddenCommits(commits, conventionalCommitsConfig) {
     if (!commits) {
         return [];
@@ -937,7 +938,9 @@ async function promptForGitHubRelease() {
         ]);
         return result.confirmation;
     }
-    catch (e) {
+    catch {
+        // Ensure the cursor is always restored
+        process.stdout.write('\u001b[?25h');
         // Handle the case where the user exits the prompt with ctrl+c
         return false;
     }

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

@@ -19,6 +19,7 @@ interface GitOptions {
     gitTagMessage?: string;
     gitTagArgs?: string | string[];
     gitPush?: boolean;
+    gitPushArgs?: string | string[];
     gitRemote?: string;
 }
 export type VersionOptions = NxReleaseArgs & GitOptions & VersionPlanArgs & FirstReleaseArgs & {
@@ -58,6 +59,7 @@ export type PlanCheckOptions = BaseNxReleaseArgs & {
 export type ReleaseOptions = NxReleaseArgs & FirstReleaseArgs & {
     specifier?: string;
     yes?: boolean;
+    preid?: VersionOptions['preid'];
     skipPublish?: boolean;
 };
 export type VersionPlanArgs = {

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

@@ -75,6 +75,11 @@ const releaseCommand = {
         .positional('specifier', {
         type: 'string',
         describe: 'Exact version or semver keyword to apply to the selected release group.',
+    })
+        .option('preid', {
+        type: 'string',
+        describe: 'The optional prerelease identifier to apply to the version. This will only be applied in the case that the specifier argument has been set to `prerelease` OR when conventional commits are enabled, in which case it will modify the resolved specifier from conventional commits to be its prerelease equivalent. E.g. minor -> preminor.',
+        default: '',
     })
         .option('yes', {
         type: 'boolean',
@@ -284,6 +289,10 @@ function withGitOptions(yargs) {
         .option('git-push', {
         describe: 'Whether or not to automatically push the changes made by this command to the remote git repository.',
         type: 'boolean',
+    })
+        .option('git-push-args', {
+        describe: 'Additional arguments to pass to the `git push` command invoked behind the scenes.',
+        type: 'string',
     })
         .option('git-remote', {
         type: 'string',

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

@@ -1,4 +1,4 @@
-import { NxJsonConfiguration } from '../../../config/nx-json';
+import { NxJsonConfiguration, NxReleaseConfiguration } from '../../../config/nx-json';
 import { ProjectFileMap, ProjectGraph } from '../../../config/project-graph';
 type DeepRequired<T> = Required<{
     [K in keyof T]: T[K] extends Required<T[K]> ? T[K] : DeepRequired<T[K]>;
@@ -25,6 +25,7 @@ type RemoveBooleanFromPropertiesOnEach<T, K extends keyof T[keyof T]> = {
     [U in keyof T]: RemoveBooleanFromProperties<T[U], K>;
 };
 export declare const IMPLICIT_DEFAULT_RELEASE_GROUP = "__default__";
+export declare const DEFAULT_VERSION_ACTIONS_PATH = "@nx/js/src/release/version-actions";
 /**
  * Our source of truth is a deeply required variant of the user-facing config interface, so that command
  * implementations can be sure that properties will exist and do not need to repeat the same checks over
@@ -34,21 +35,21 @@ export declare const IMPLICIT_DEFAULT_RELEASE_GROUP = "__default__";
  * it easier to work with (the user could be specifying a single string, and they can also use any valid matcher
  * pattern such as directories and globs).
  */
-export type NxReleaseConfig = Omit<DeepRequired<NxJsonConfiguration['release'] & {
-    groups: DeepRequired<RemoveTrueFromPropertiesOnEach<EnsureProjectsArray<NxJsonConfiguration['release']['groups']>, 'changelog'>>;
-    changelog: RemoveTrueFromProperties<DeepRequired<NxJsonConfiguration['release']['changelog']>, 'workspaceChangelog' | 'projectChangelogs'>;
+export type NxReleaseConfig = Omit<DeepRequired<NxReleaseConfiguration & {
+    groups: DeepRequired<RemoveTrueFromPropertiesOnEach<EnsureProjectsArray<NxReleaseConfiguration['groups']>, 'changelog'>>;
+    changelog: RemoveTrueFromProperties<DeepRequired<NxReleaseConfiguration['changelog']>, 'workspaceChangelog' | 'projectChangelogs'>;
     conventionalCommits: {
-        types: RemoveBooleanFromPropertiesOnEach<DeepRequired<RemoveBooleanFromProperties<DeepRequired<NxJsonConfiguration['release']['conventionalCommits']['types']>, string>>, 'changelog'>;
+        types: RemoveBooleanFromPropertiesOnEach<DeepRequired<RemoveBooleanFromProperties<DeepRequired<NxReleaseConfiguration['conventionalCommits']['types']>, string>>, 'changelog'>;
     };
 }>, 'projects'>;
 export interface CreateNxReleaseConfigError {
-    code: 'PROJECTS_AND_GROUPS_DEFINED' | 'RELEASE_GROUP_MATCHES_NO_PROJECTS' | 'RELEASE_GROUP_RELEASE_TAG_PATTERN_VERSION_PLACEHOLDER_MISSING_OR_EXCESSIVE' | 'PROJECT_MATCHES_MULTIPLE_GROUPS' | 'CONVENTIONAL_COMMITS_SHORTHAND_MIXED_WITH_OVERLAPPING_GENERATOR_OPTIONS' | 'GLOBAL_GIT_CONFIG_MIXED_WITH_GRANULAR_GIT_CONFIG' | 'CANNOT_RESOLVE_CHANGELOG_RENDERER' | 'INVALID_CHANGELOG_CREATE_RELEASE_PROVIDER' | 'INVALID_CHANGELOG_CREATE_RELEASE_HOSTNAME' | 'INVALID_CHANGELOG_CREATE_RELEASE_API_BASE_URL' | 'GIT_PUSH_FALSE_WITH_CREATE_RELEASE';
+    code: 'PROJECTS_AND_GROUPS_DEFINED' | 'RELEASE_GROUP_MATCHES_NO_PROJECTS' | 'RELEASE_GROUP_RELEASE_TAG_PATTERN_VERSION_PLACEHOLDER_MISSING_OR_EXCESSIVE' | 'PROJECT_MATCHES_MULTIPLE_GROUPS' | 'CONVENTIONAL_COMMITS_SHORTHAND_MIXED_WITH_OVERLAPPING_OPTIONS' | 'GLOBAL_GIT_CONFIG_MIXED_WITH_GRANULAR_GIT_CONFIG' | 'CANNOT_RESOLVE_CHANGELOG_RENDERER' | 'INVALID_CHANGELOG_CREATE_RELEASE_PROVIDER' | 'INVALID_CHANGELOG_CREATE_RELEASE_HOSTNAME' | 'INVALID_CHANGELOG_CREATE_RELEASE_API_BASE_URL' | 'GIT_PUSH_FALSE_WITH_CREATE_RELEASE';
     data: Record<string, string | string[]>;
 }
 export declare function createNxReleaseConfig(projectGraph: ProjectGraph, projectFileMap: ProjectFileMap, userConfig?: NxJsonConfiguration['release']): Promise<{
     error: null | CreateNxReleaseConfigError;
     nxReleaseConfig: NxReleaseConfig | null;
 }>;
-export declare function handleNxReleaseConfigError(error: CreateNxReleaseConfigError): Promise<never>;
+export declare function handleNxReleaseConfigError(error: CreateNxReleaseConfigError, useLegacyVersioning: boolean): Promise<never>;
 export declare const defaultCreateReleaseProvider: any;
 export {};

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultCreateReleaseProvider = exports.IMPLICIT_DEFAULT_RELEASE_GROUP = void 0;
+exports.defaultCreateReleaseProvider = exports.DEFAULT_VERSION_ACTIONS_PATH = exports.IMPLICIT_DEFAULT_RELEASE_GROUP = void 0;
 exports.createNxReleaseConfig = createNxReleaseConfig;
 exports.handleNxReleaseConfigError = handleNxReleaseConfigError;
 /**
@@ -21,12 +21,14 @@ const node_url_1 = require("node:url");
 const fileutils_1 = require("../../../utils/fileutils");
 const find_matching_projects_1 = require("../../../utils/find-matching-projects");
 const output_1 = require("../../../utils/output");
-const workspace_root_1 = require("../../../utils/workspace-root");
 const path_1 = require("../../../utils/path");
+const workspace_root_1 = require("../../../utils/workspace-root");
 const resolve_changelog_renderer_1 = require("../utils/resolve-changelog-renderer");
 const resolve_nx_json_error_message_1 = require("../utils/resolve-nx-json-error-message");
 const conventional_commits_1 = require("./conventional-commits");
+const use_legacy_versioning_1 = require("./use-legacy-versioning");
 exports.IMPLICIT_DEFAULT_RELEASE_GROUP = '__default__';
+exports.DEFAULT_VERSION_ACTIONS_PATH = '@nx/js/src/release/version-actions';
 // Apply default configuration to any optional user configuration and handle known errors
 async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig = {}) {
     if (userConfig.projects && userConfig.groups) {
@@ -50,12 +52,13 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
     if (hasInvalidConventionalCommitsConfig(userConfig)) {
         return {
             error: {
-                code: 'CONVENTIONAL_COMMITS_SHORTHAND_MIXED_WITH_OVERLAPPING_GENERATOR_OPTIONS',
+                code: 'CONVENTIONAL_COMMITS_SHORTHAND_MIXED_WITH_OVERLAPPING_OPTIONS',
                 data: {},
             },
             nxReleaseConfig: null,
         };
     }
+    const USE_LEGACY_VERSIONING = (0, use_legacy_versioning_1.shouldUseLegacyVersioning)(userConfig);
     const gitDefaults = {
         commit: false,
         commitMessage: 'chore(release): publish {version}',
@@ -65,6 +68,7 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
         tagArgs: '',
         stageChanges: false,
         push: false,
+        pushArgs: '',
     };
     const versionGitDefaults = {
         ...gitDefaults,
@@ -133,11 +137,24 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
         projectsRelationship: workspaceProjectsRelationship,
         git: gitDefaults,
         version: {
+            useLegacyVersioning: USE_LEGACY_VERSIONING,
             git: versionGitDefaults,
             conventionalCommits: userConfig.version?.conventionalCommits || false,
-            generator: '@nx/js:release-version',
-            generatorOptions: defaultGeneratorOptions,
             preVersionCommand: userConfig.version?.preVersionCommand || '',
+            ...(USE_LEGACY_VERSIONING
+                ? {
+                    generator: '@nx/js:release-version',
+                    generatorOptions: defaultGeneratorOptions,
+                }
+                : {
+                    versionActions: exports.DEFAULT_VERSION_ACTIONS_PATH,
+                    versionActionsOptions: {},
+                    currentVersionResolver: defaultGeneratorOptions.currentVersionResolver,
+                    specifierSource: defaultGeneratorOptions.specifierSource,
+                    preserveLocalDependencyProtocols: userConfig.version?.preserveLocalDependencyProtocols ?? true,
+                    logUnchangedProjects: userConfig.version?.logUnchangedProjects ?? true,
+                    updateDependents: userConfig.version?.updateDependents ?? 'auto',
+                }),
         },
         changelog: {
             git: changelogGitDefaults,
@@ -177,6 +194,7 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
             (workspaceProjectsRelationship === 'independent'
                 ? defaultIndependentReleaseTagPattern
                 : defaultFixedReleaseTagPattern),
+        releaseTagPatternCheckAllBranchesWhen: userConfig.releaseTagPatternCheckAllBranchesWhen ?? undefined,
         conventionalCommits: conventional_commits_1.DEFAULT_CONVENTIONAL_COMMITS_CONFIG,
         versionPlans: (userConfig.versionPlans ||
             false),
@@ -184,12 +202,19 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
     const groupProjectsRelationship = userConfig.projectsRelationship || WORKSPACE_DEFAULTS.projectsRelationship;
     const GROUP_DEFAULTS = {
         projectsRelationship: groupProjectsRelationship,
-        version: {
-            conventionalCommits: false,
-            generator: '@nx/js:release-version',
-            generatorOptions: {},
-            groupPreVersionCommand: '',
-        },
+        version: USE_LEGACY_VERSIONING
+            ? {
+                conventionalCommits: false,
+                generator: '@nx/js:release-version',
+                generatorOptions: {},
+                groupPreVersionCommand: '',
+            }
+            : {
+                conventionalCommits: false,
+                versionActions: exports.DEFAULT_VERSION_ACTIONS_PATH,
+                versionActionsOptions: {},
+                groupPreVersionCommand: '',
+            },
         changelog: {
             createRelease: false,
             entryWhenNoChanges: 'This was a version bump only for {projectName} to align it with other projects, there were no code changes.',
@@ -207,6 +232,7 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
         groupProjectsRelationship === 'independent'
             ? defaultIndependentReleaseTagPattern
             : WORKSPACE_DEFAULTS.releaseTagPattern,
+        releaseTagPatternCheckAllBranchesWhen: userConfig.releaseTagPatternCheckAllBranchesWhen ?? undefined,
         versionPlans: false,
     };
     /**
@@ -217,7 +243,9 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
     const rootVersionConfig = deepMergeDefaults([
         WORKSPACE_DEFAULTS.version,
         // Merge in the git defaults from the top level
-        { git: versionGitDefaults },
+        {
+            git: versionGitDefaults,
+        },
         {
             git: userConfig.git,
         },
@@ -240,33 +268,50 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
         WORKSPACE_DEFAULTS.versionPlans);
     const rootConventionalCommitsConfig = deepMergeDefaults([WORKSPACE_DEFAULTS.conventionalCommits], fillUnspecifiedConventionalCommitsProperties(normalizeConventionalCommitsConfig(userConfig.conventionalCommits)));
     // these options are not supported at the group level, only the root/command level
-    const rootVersionWithoutGlobalOptions = {
+    let rootVersionWithoutGlobalOptions = {
         ...rootVersionConfig,
     };
     delete rootVersionWithoutGlobalOptions.git;
     delete rootVersionWithoutGlobalOptions.preVersionCommand;
     // Apply conventionalCommits shorthand to the final group defaults if explicitly configured in the original user config
     if (userConfig.version?.conventionalCommits === true) {
-        rootVersionWithoutGlobalOptions.generatorOptions = {
-            ...rootVersionWithoutGlobalOptions.generatorOptions,
-            currentVersionResolver: 'git-tag',
-            specifierSource: 'conventional-commits',
-        };
+        if (USE_LEGACY_VERSIONING) {
+            rootVersionWithoutGlobalOptions.generatorOptions = {
+                ...rootVersionWithoutGlobalOptions.generatorOptions,
+                currentVersionResolver: 'git-tag',
+                specifierSource: 'conventional-commits',
+            };
+        }
+        else {
+            rootVersionWithoutGlobalOptions.currentVersionResolver = 'git-tag';
+            rootVersionWithoutGlobalOptions.specifierSource = 'conventional-commits';
+        }
     }
     if (userConfig.version?.conventionalCommits === false) {
         delete rootVersionWithoutGlobalOptions.generatorOptions
             .currentVersionResolver;
         delete rootVersionWithoutGlobalOptions.generatorOptions.specifierSource;
+        delete rootVersionWithoutGlobalOptions
+            .currentVersionResolver;
+        delete rootVersionWithoutGlobalOptions
+            .specifierSource;
     }
     // Apply versionPlans shorthand to the final group defaults if explicitly configured in the original user config
     if (userConfig.versionPlans) {
-        rootVersionWithoutGlobalOptions.generatorOptions = {
-            ...rootVersionWithoutGlobalOptions.generatorOptions,
-            specifierSource: 'version-plans',
-        };
+        if (USE_LEGACY_VERSIONING) {
+            rootVersionWithoutGlobalOptions.generatorOptions = {
+                ...rootVersionWithoutGlobalOptions.generatorOptions,
+                specifierSource: 'version-plans',
+            };
+        }
+        else {
+            rootVersionWithoutGlobalOptions.specifierSource = 'version-plans';
+        }
     }
     if (userConfig.versionPlans === false) {
         delete rootVersionWithoutGlobalOptions.generatorOptions.specifierSource;
+        delete rootVersionWithoutGlobalOptions
+            .specifierSource;
     }
     const groups = userConfig.groups && Object.keys(userConfig.groups).length
         ? ensureProjectsConfigIsArray(userConfig.groups)
@@ -365,6 +410,9 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
                 (projectsRelationship === 'independent'
                     ? defaultIndependentReleaseTagPattern
                     : userConfig.releaseTagPattern || defaultFixedReleaseTagPattern),
+            releaseTagPatternCheckAllBranchesWhen: releaseGroup.releaseTagPatternCheckAllBranchesWhen ??
+                userConfig.releaseTagPatternCheckAllBranchesWhen ??
+                undefined,
             versionPlans: releaseGroup.versionPlans ?? rootVersionPlansConfig,
         };
         const finalReleaseGroup = deepMergeDefaults([groupDefaults], {
@@ -372,32 +420,51 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
             // Ensure that the resolved project names take priority over the original user config (which could have contained unresolved globs etc)
             projects: matchingProjects,
         });
+        finalReleaseGroup.version =
+            finalReleaseGroup.version;
         // Apply conventionalCommits shorthand to the final group if explicitly configured in the original group
         if (releaseGroup.version?.conventionalCommits === true) {
-            finalReleaseGroup.version.generatorOptions = {
-                ...finalReleaseGroup.version.generatorOptions,
-                currentVersionResolver: 'git-tag',
-                specifierSource: 'conventional-commits',
-            };
+            if (USE_LEGACY_VERSIONING) {
+                finalReleaseGroup.version.generatorOptions = {
+                    ...finalReleaseGroup.version.generatorOptions,
+                    currentVersionResolver: 'git-tag',
+                    specifierSource: 'conventional-commits',
+                };
+            }
+            else {
+                finalReleaseGroup.version.currentVersionResolver = 'git-tag';
+                finalReleaseGroup.version.specifierSource = 'conventional-commits';
+            }
         }
         if (releaseGroup.version?.conventionalCommits === false &&
             releaseGroupName !== exports.IMPLICIT_DEFAULT_RELEASE_GROUP) {
             delete finalReleaseGroup.version.generatorOptions.currentVersionResolver;
             delete finalReleaseGroup.version.generatorOptions.specifierSource;
+            delete finalReleaseGroup.version
+                .currentVersionResolver;
+            delete finalReleaseGroup.version
+                .specifierSource;
         }
         // Apply versionPlans shorthand to the final group if explicitly configured in the original group
         if (releaseGroup.versionPlans) {
-            finalReleaseGroup.version = {
-                ...finalReleaseGroup.version,
-                generatorOptions: {
-                    ...finalReleaseGroup.version?.generatorOptions,
-                    specifierSource: 'version-plans',
-                },
-            };
+            if (USE_LEGACY_VERSIONING) {
+                finalReleaseGroup.version = {
+                    ...finalReleaseGroup.version,
+                    generatorOptions: {
+                        ...finalReleaseGroup.version?.generatorOptions,
+                        specifierSource: 'version-plans',
+                    },
+                };
+            }
+            else {
+                finalReleaseGroup.version.specifierSource = 'version-plans';
+            }
         }
         if (releaseGroup.versionPlans === false &&
             releaseGroupName !== exports.IMPLICIT_DEFAULT_RELEASE_GROUP) {
             delete finalReleaseGroup.version.generatorOptions.specifierSource;
+            delete finalReleaseGroup.version
+                .specifierSource;
         }
         releaseGroups[releaseGroupName] = finalReleaseGroup;
     }
@@ -413,6 +480,7 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
         nxReleaseConfig: {
             projectsRelationship: WORKSPACE_DEFAULTS.projectsRelationship,
             releaseTagPattern: WORKSPACE_DEFAULTS.releaseTagPattern,
+            releaseTagPatternCheckAllBranchesWhen: WORKSPACE_DEFAULTS.releaseTagPatternCheckAllBranchesWhen,
             git: rootGitConfig,
             version: rootVersionConfig,
             changelog: rootChangelogConfig,
@@ -511,7 +579,7 @@ function fillUnspecifiedConventionalCommitsProperties(config) {
         types,
     };
 }
-async function handleNxReleaseConfigError(error) {
+async function handleNxReleaseConfigError(error, useLegacyVersioning) {
     switch (error.code) {
         case 'PROJECTS_AND_GROUPS_DEFINED':
             {
@@ -563,13 +631,16 @@ async function handleNxReleaseConfigError(error) {
                 });
             }
             break;
-        case 'CONVENTIONAL_COMMITS_SHORTHAND_MIXED_WITH_OVERLAPPING_GENERATOR_OPTIONS':
+        case 'CONVENTIONAL_COMMITS_SHORTHAND_MIXED_WITH_OVERLAPPING_OPTIONS':
             {
                 const nxJsonMessage = await (0, resolve_nx_json_error_message_1.resolveNxJsonConfigErrorMessage)([
                     'release',
                 ]);
+                const text = useLegacyVersioning
+                    ? '"version.generatorOptions"'
+                    : 'configuration options';
                 output_1.output.error({
-                    title: `You have configured both the shorthand "version.conventionalCommits" and one or more of the related "version.generatorOptions" that it sets for you. Please use one or the other:`,
+                    title: `You have configured both the shorthand "version.conventionalCommits" and one or more of the related ${text} that it sets for you. Please use one or the other:`,
                     bodyLines: [nxJsonMessage],
                 });
             }
@@ -592,6 +663,7 @@ async function handleNxReleaseConfigError(error) {
                 title: `There was an error when resolving the configured changelog renderer at path: ${error.data.workspaceRelativePath}`,
                 bodyLines: [nxJsonMessage],
             });
+            break;
         }
         case 'INVALID_CHANGELOG_CREATE_RELEASE_PROVIDER':
             {
@@ -716,21 +788,36 @@ function deepMergeDefaults(defaultConfigs, userConfig) {
 }
 /**
  * We want to prevent users from setting both the conventionalCommits shorthand and any of the related
- * generatorOptions at the same time, since it is at best redundant, and at worst invalid.
+ * configuration options at the same time, since it is at best redundant, and at worst invalid.
  */
 function hasInvalidConventionalCommitsConfig(userConfig) {
     // at the root
     if (userConfig.version?.conventionalCommits === true &&
-        (userConfig.version?.generatorOptions?.currentVersionResolver ||
-            userConfig.version?.generatorOptions?.specifierSource)) {
+        // v2 config - directly on version config
+        (userConfig.version
+            ?.currentVersionResolver ||
+            userConfig.version
+                ?.specifierSource ||
+            // Legacy config - on generatorOptions
+            userConfig.version
+                ?.generatorOptions?.currentVersionResolver ||
+            userConfig.version
+                ?.generatorOptions?.specifierSource)) {
         return true;
     }
     // within any groups
     if (userConfig.groups) {
         for (const group of Object.values(userConfig.groups)) {
             if (group.version?.conventionalCommits === true &&
-                (group.version?.generatorOptions?.currentVersionResolver ||
-                    group.version?.generatorOptions?.specifierSource)) {
+                // v2 config - directly on version config
+                (group.version
+                    ?.currentVersionResolver ||
+                    group.version?.specifierSource ||
+                    // Legacy config - on generatorOptions
+                    group.version
+                        ?.generatorOptions?.currentVersionResolver ||
+                    group.version
+                        ?.generatorOptions?.specifierSource)) {
                 return true;
             }
         }

package/src/command-line/release/config/use-legacy-versioning.d.ts

@@ -0,0 +1,2 @@
+import type { NxJsonConfiguration } from '../../../config/nx-json';
+export declare function shouldUseLegacyVersioning(releaseConfig: NxJsonConfiguration['release'] | undefined): boolean;

package/src/command-line/release/config/use-legacy-versioning.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldUseLegacyVersioning = shouldUseLegacyVersioning;
+function shouldUseLegacyVersioning(releaseConfig) {
+    return process.env.NX_INTERNAL_USE_LEGACY_VERSIONING === 'false'
+        ? false
+        : // TODO(v21): switch this to false by default in Nx v21 and remove this function in v22
+            releaseConfig?.version?.useLegacyVersioning ?? true;
+}

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

@@ -31,3 +31,7 @@ export declare const releaseVersion: typeof defaultClient.releaseVersion;
  * @public
  */
 export declare const release: typeof defaultClient.release;
+/**
+ * @public
+ */
+export { AfterAllProjectsVersioned, VersionActions, } from './version/version-actions';

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.release = exports.releaseVersion = exports.releasePublish = exports.releaseChangelog = exports.ReleaseClient = void 0;
+exports.VersionActions = exports.release = exports.releaseVersion = exports.releasePublish = exports.releaseChangelog = exports.ReleaseClient = void 0;
 const changelog_1 = require("./changelog");
 const publish_1 = require("./publish");
 const release_1 = require("./release");
@@ -35,3 +35,8 @@ exports.releaseVersion = defaultClient.releaseVersion.bind(defaultClient);
  * @public
  */
 exports.release = defaultClient.release.bind(defaultClient);
+/**
+ * @public
+ */
+var version_actions_1 = require("./version/version-actions");
+Object.defineProperty(exports, "VersionActions", { enumerable: true, get: function () { return version_actions_1.VersionActions; } });

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

@@ -7,11 +7,12 @@ const file_map_utils_1 = require("../../project-graph/file-map-utils");
 const project_graph_1 = require("../../project-graph/project-graph");
 const all_file_data_1 = require("../../utils/all-file-data");
 const command_line_utils_1 = require("../../utils/command-line-utils");
-const output_1 = require("../../utils/output");
 const handle_errors_1 = require("../../utils/handle-errors");
+const output_1 = require("../../utils/output");
 const config_1 = require("./config/config");
 const deep_merge_json_1 = require("./config/deep-merge-json");
 const filter_release_groups_1 = require("./config/filter-release-groups");
+const use_legacy_versioning_1 = require("./config/use-legacy-versioning");
 const version_plans_1 = require("./config/version-plans");
 const get_touched_projects_for_group_1 = require("./utils/get-touched-projects-for-group");
 const print_config_1 = require("./utils/print-config");
@@ -25,7 +26,8 @@ function createAPI(overrideReleaseConfig) {
         // Apply default configuration to any optional user configuration
         const { error: configError, nxReleaseConfig } = await (0, config_1.createNxReleaseConfig)(projectGraph, await (0, file_map_utils_1.createProjectFileMapUsingProjectGraph)(projectGraph), userProvidedReleaseConfig);
         if (configError) {
-            return await (0, config_1.handleNxReleaseConfigError)(configError);
+            const USE_LEGACY_VERSIONING = (0, use_legacy_versioning_1.shouldUseLegacyVersioning)(userProvidedReleaseConfig);
+            return await (0, config_1.handleNxReleaseConfigError)(configError, USE_LEGACY_VERSIONING);
         }
         // --print-config exits directly as it is not designed to be combined with any other programmatic operations
         if (args.printConfig) {
@@ -47,7 +49,8 @@ function createAPI(overrideReleaseConfig) {
                 title: 'Version plans are not enabled',
                 bodyLines: [
                     'Please ensure at least one release group has version plans enabled in your Nx release configuration if you want to use this command.',
-                    // TODO: Add docs link here once it is available
+                    '',
+                    'Learn more about version plans here: https://nx.dev/recipes/nx-release/file-based-versioning-version-plans',
                 ],
             });
             return 1;