nx 18.1.0-canary.20240301-d705372 → 18.1.0-canary.20240306-cc2f655

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

@@ -4,7 +4,7 @@ import { ReleaseGroupWithName } from './config/filter-release-groups';
 import { VersionData } from './utils/shared';
 export { deriveNewSemverVersion } from './utils/semver';
 export type { ReleaseVersionGeneratorResult, VersionData, } from './utils/shared';
-export declare const validReleaseVersionPrefixes: string[];
+export declare const validReleaseVersionPrefixes: readonly ["auto", "", "~", "^", "="];
 export interface ReleaseVersionGeneratorSchema {
     projects: ProjectGraphProjectNode[];
     releaseGroup: ReleaseGroupWithName;
@@ -18,6 +18,9 @@ export interface ReleaseVersionGeneratorSchema {
     fallbackCurrentVersionResolver?: 'disk';
     firstRelease?: boolean;
     versionPrefix?: typeof validReleaseVersionPrefixes[number];
+    skipLockFileUpdate?: boolean;
+    installArgs?: string;
+    installIgnoreScripts?: boolean;
 }
 export interface NxReleaseVersionResult {
     /**

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

@@ -2,13 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.releaseVersion = exports.releaseVersionCLIHandler = exports.validReleaseVersionPrefixes = exports.deriveNewSemverVersion = void 0;
 const chalk = require("chalk");
+const node_child_process_1 = require("node:child_process");
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const nx_json_1 = require("../../config/nx-json");
-const devkit_exports_1 = require("../../devkit-exports");
 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 output_1 = require("../../utils/output");
 const params_1 = require("../../utils/params");
+const path_1 = require("../../utils/path");
+const workspace_root_1 = require("../../utils/workspace-root");
 const generate_1 = require("../generate/generate");
 const generator_utils_1 = require("../generate/generator-utils");
 const config_1 = require("./config/config");
@@ -18,10 +22,11 @@ const git_1 = require("./utils/git");
 const print_changes_1 = require("./utils/print-changes");
 const resolve_nx_json_error_message_1 = require("./utils/resolve-nx-json-error-message");
 const shared_1 = require("./utils/shared");
+const LARGE_BUFFER = 1024 * 1000000;
 // Reexport some utils for use in plugin release-version generator implementations
 var semver_1 = require("./utils/semver");
 Object.defineProperty(exports, "deriveNewSemverVersion", { enumerable: true, get: function () { return semver_1.deriveNewSemverVersion; } });
-exports.validReleaseVersionPrefixes = ['auto', '', '~', '^'];
+exports.validReleaseVersionPrefixes = ['auto', '', '~', '^', '='];
 const releaseVersionCLIHandler = (args) => (0, params_1.handleErrors)(args.verbose, () => releaseVersion(args));
 exports.releaseVersionCLIHandler = releaseVersionCLIHandler;
 /**
@@ -37,7 +42,7 @@ async function releaseVersion(args) {
         process.env.NX_VERBOSE_LOGGING = 'true';
     }
     // Apply default configuration to any optional user configuration
-    const { error: configError, nxReleaseConfig } = await (0, config_1.createNxReleaseConfig)(projectGraph, nxJson.release);
+    const { error: configError, nxReleaseConfig } = await (0, config_1.createNxReleaseConfig)(projectGraph, await (0, file_map_utils_1.createProjectFileMapUsingProjectGraph)(projectGraph), nxJson.release);
     if (configError) {
         return await (0, config_1.handleNxReleaseConfigError)(configError);
     }
@@ -53,7 +58,7 @@ async function releaseVersion(args) {
             'release',
             'git',
         ]);
-        devkit_exports_1.output.error({
+        output_1.output.error({
             title: `The "release.git" property in nx.json may not be used with the "nx release version" subcommand or programmatic API. Instead, configure git options for subcommands directly with "release.version.git" and "release.changelog.git".`,
             bodyLines: [nxJsonMessage],
         });
@@ -61,10 +66,14 @@ async function releaseVersion(args) {
     }
     const { error: filterError, releaseGroups, releaseGroupToFilteredProjects, } = (0, filter_release_groups_1.filterReleaseGroups)(projectGraph, nxReleaseConfig, args.projects, args.groups);
     if (filterError) {
-        devkit_exports_1.output.error(filterError);
+        output_1.output.error(filterError);
         process.exit(1);
     }
-    const tree = new tree_1.FsTree(devkit_exports_1.workspaceRoot, args.verbose);
+    runPreVersionCommand(nxReleaseConfig.version.preVersionCommand, {
+        dryRun: args.dryRun,
+        verbose: args.verbose,
+    });
+    const tree = new tree_1.FsTree(workspace_root_1.workspaceRoot, args.verbose);
     const versionData = {};
     const commitMessage = args.gitCommitMessage || nxReleaseConfig.version.git.commitMessage;
     const additionalChangedFiles = new Set();
@@ -88,13 +97,16 @@ async function releaseVersion(args) {
                     // all project data from the project graph (not to be confused with projectNamesToRunVersionOn)
                     projects,
                 });
-                const generatorCallback = await runVersionOnProjects(projectGraph, nxJson, args, tree, generatorData, projectNames, releaseGroup, versionData);
+                const generatorCallback = await runVersionOnProjects(projectGraph, nxJson, args, tree, generatorData, args.generatorOptionsOverrides, projectNames, releaseGroup, versionData);
                 // Capture the callback so that we can run it after flushing the changes to disk
                 generatorCallbacks.push(async () => {
                     const changedFiles = await generatorCallback(tree, {
                         dryRun: !!args.dryRun,
                         verbose: !!args.verbose,
-                        generatorOptions,
+                        generatorOptions: {
+                            ...generatorOptions,
+                            ...args.generatorOptionsOverrides,
+                        },
                     });
                     changedFiles.forEach((f) => additionalChangedFiles.add(f));
                 });
@@ -125,7 +137,7 @@ async function releaseVersion(args) {
             await (0, shared_1.commitChanges)(changedFiles, !!args.dryRun, !!args.verbose, (0, shared_1.createCommitMessageValues)(releaseGroups, releaseGroupToFilteredProjects, versionData, commitMessage), args.gitCommitArgs || nxReleaseConfig.version.git.commitArgs);
         }
         else if (args.stageChanges ?? nxReleaseConfig.version.git.stageChanges) {
-            devkit_exports_1.output.logSingleLine(`Staging changed files with git`);
+            output_1.output.logSingleLine(`Staging changed files with git`);
             await (0, git_1.gitAdd)({
                 changedFiles,
                 dryRun: args.dryRun,
@@ -133,7 +145,7 @@ async function releaseVersion(args) {
             });
         }
         if (args.gitTag ?? nxReleaseConfig.version.git.tag) {
-            devkit_exports_1.output.logSingleLine(`Tagging commit with git`);
+            output_1.output.logSingleLine(`Tagging commit with git`);
             for (const tag of gitTagValues) {
                 await (0, git_1.gitTag)({
                     tag,
@@ -167,13 +179,16 @@ async function releaseVersion(args) {
                 // all project data from the project graph (not to be confused with projectNamesToRunVersionOn)
                 projects,
             });
-            const generatorCallback = await runVersionOnProjects(projectGraph, nxJson, args, tree, generatorData, projectNames, releaseGroup, versionData);
+            const generatorCallback = await runVersionOnProjects(projectGraph, nxJson, args, tree, generatorData, args.generatorOptionsOverrides, projectNames, releaseGroup, versionData);
             // Capture the callback so that we can run it after flushing the changes to disk
             generatorCallbacks.push(async () => {
                 const changedFiles = await generatorCallback(tree, {
                     dryRun: !!args.dryRun,
                     verbose: !!args.verbose,
-                    generatorOptions,
+                    generatorOptions: {
+                        ...generatorOptions,
+                        ...args.generatorOptionsOverrides,
+                    },
                 });
                 changedFiles.forEach((f) => additionalChangedFiles.add(f));
             });
@@ -212,7 +227,7 @@ async function releaseVersion(args) {
         await (0, shared_1.commitChanges)(changedFiles, !!args.dryRun, !!args.verbose, (0, shared_1.createCommitMessageValues)(releaseGroups, releaseGroupToFilteredProjects, versionData, commitMessage), args.gitCommitArgs || nxReleaseConfig.version.git.commitArgs);
     }
     else if (args.stageChanges ?? nxReleaseConfig.version.git.stageChanges) {
-        devkit_exports_1.output.logSingleLine(`Staging changed files with git`);
+        output_1.output.logSingleLine(`Staging changed files with git`);
         await (0, git_1.gitAdd)({
             changedFiles,
             dryRun: args.dryRun,
@@ -220,7 +235,7 @@ async function releaseVersion(args) {
         });
     }
     if (args.gitTag ?? nxReleaseConfig.version.git.tag) {
-        devkit_exports_1.output.logSingleLine(`Tagging commit with git`);
+        output_1.output.logSingleLine(`Tagging commit with git`);
         for (const tag of gitTagValues) {
             await (0, git_1.gitTag)({
                 tag,
@@ -247,12 +262,13 @@ function appendVersionData(existingVersionData, newVersionData) {
     }
     return existingVersionData;
 }
-async function runVersionOnProjects(projectGraph, nxJson, args, tree, generatorData, projectNames, releaseGroup, versionData) {
+async function runVersionOnProjects(projectGraph, nxJson, args, tree, generatorData, generatorOverrides, projectNames, releaseGroup, versionData) {
     const generatorOptions = {
         // Always ensure a string to avoid generator schema validation errors
         specifier: args.specifier ?? '',
         preid: args.preid ?? '',
         ...generatorData.configGeneratorOptions,
+        ...(generatorOverrides ?? {}),
         // The following are not overridable by user config
         projects: projectNames.map((p) => projectGraph.nodes[p]),
         projectGraph,
@@ -260,7 +276,7 @@ async function runVersionOnProjects(projectGraph, nxJson, args, tree, generatorD
         firstRelease: args.firstRelease ?? false,
     };
     // Apply generator defaults from schema.json file etc
-    const combinedOpts = await (0, params_1.combineOptionsForGenerator)(generatorOptions, generatorData.collectionName, generatorData.normalizedGeneratorName, (0, project_graph_1.readProjectsConfigurationFromProjectGraph)(projectGraph), nxJson, generatorData.schema, false, null, (0, node_path_1.relative)(process.cwd(), devkit_exports_1.workspaceRoot), args.verbose);
+    const combinedOpts = await (0, params_1.combineOptionsForGenerator)(generatorOptions, generatorData.collectionName, generatorData.normalizedGeneratorName, (0, project_graph_1.readProjectsConfigurationFromProjectGraph)(projectGraph), nxJson, generatorData.schema, false, null, (0, node_path_1.relative)(process.cwd(), workspace_root_1.workspaceRoot), args.verbose);
     const releaseVersionGenerator = generatorData.implementationFactory();
     // We expect all version generator implementations to return a ReleaseVersionGeneratorResult object, rather than a GeneratorCallback
     const versionResult = (await releaseVersionGenerator(tree, combinedOpts));
@@ -282,7 +298,7 @@ function printAndFlushChanges(tree, isDryRun) {
         }
         else if (f.type === 'UPDATE') {
             console.error(`${chalk.white('UPDATE')} ${f.path}${isDryRun ? chalk.keyword('orange')(' [dry-run]') : ''}`);
-            const currentContentsOnDisk = (0, node_fs_1.readFileSync)((0, devkit_exports_1.joinPathFragments)(tree.root, f.path)).toString();
+            const currentContentsOnDisk = (0, node_fs_1.readFileSync)((0, path_1.joinPathFragments)(tree.root, f.path)).toString();
             (0, print_changes_1.printDiff)(currentContentsOnDisk, f.content?.toString() || '');
         }
         else if (f.type === 'DELETE') {
@@ -290,7 +306,7 @@ function printAndFlushChanges(tree, isDryRun) {
         }
     });
     if (!isDryRun) {
-        (0, tree_1.flushChanges)(devkit_exports_1.workspaceRoot, changes);
+        (0, tree_1.flushChanges)(workspace_root_1.workspaceRoot, changes);
     }
 }
 function extractGeneratorCollectionAndName(description, generatorString) {
@@ -306,7 +322,7 @@ function extractGeneratorCollectionAndName(description, generatorString) {
 }
 function resolveGeneratorData({ collectionName, generatorName, configGeneratorOptions, projects, }) {
     try {
-        const { normalizedGeneratorName, schema, implementationFactory } = (0, generator_utils_1.getGeneratorInformation)(collectionName, generatorName, devkit_exports_1.workspaceRoot, projects);
+        const { normalizedGeneratorName, schema, implementationFactory } = (0, generator_utils_1.getGeneratorInformation)(collectionName, generatorName, workspace_root_1.workspaceRoot, projects);
         return {
             collectionName,
             generatorName,
@@ -339,3 +355,38 @@ function resolveGeneratorData({ collectionName, generatorName, configGeneratorOp
         throw err;
     }
 }
+function runPreVersionCommand(preVersionCommand, { dryRun, verbose }) {
+    if (!preVersionCommand) {
+        return;
+    }
+    output_1.output.logSingleLine(`Executing pre-version command`);
+    if (verbose) {
+        console.log(`Executing the following pre-version command:`);
+        console.log(preVersionCommand);
+    }
+    let env = {
+        ...process.env,
+    };
+    if (dryRun) {
+        env.NX_DRY_RUN = 'true';
+    }
+    const stdio = verbose ? 'inherit' : 'pipe';
+    try {
+        (0, node_child_process_1.execSync)(preVersionCommand, {
+            encoding: 'utf-8',
+            maxBuffer: LARGE_BUFFER,
+            stdio,
+            env,
+        });
+    }
+    catch (e) {
+        const title = verbose
+            ? `The pre-version command failed. See the full output above.`
+            : `The pre-version command failed. Retry with --verbose to see the full output of the pre-version command.`;
+        output_1.output.error({
+            title,
+            bodyLines: [preVersionCommand, e],
+        });
+        process.exit(1);
+    }
+}

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

@@ -207,6 +207,12 @@ interface NxReleaseConfiguration {
          * Enable or override configuration for git operations as part of the version subcommand
          */
         git?: NxReleaseGitConfiguration;
+        /**
+         * A command to run after validation of nx release configuration, but before versioning begins.
+         * Used for preparing build artifacts. If --dry-run is passed, the command is still executed, but
+         * with the NX_DRY_RUN environment variable set to 'true'.
+         */
+        preVersionCommand?: string;
     };
     /**
      * Optionally override the git/release tag pattern to use. This field is the source of truth