nx 20.7.2 → 20.8.0-beta.1

package/.eslintrc.json

@@ -134,7 +134,9 @@
               "@nx/key",
               // Powerpack plugin conditionally available dynamically at runtime
               "@nx/powerpack-conformance",
-              "@nx/conformance"
+              "@nx/conformance",
+              // Only used in test-utils at the time of writing
+              "@ltd/j-toml"
             ]
           }
         ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nx",
-  "version": "20.7.2",
+  "version": "20.8.0-beta.1",
   "private": false,
   "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
   "repository": {
@@ -82,16 +82,16 @@
     }
   },
   "optionalDependencies": {
-    "@nx/nx-darwin-arm64": "20.7.2",
-    "@nx/nx-darwin-x64": "20.7.2",
-    "@nx/nx-freebsd-x64": "20.7.2",
-    "@nx/nx-linux-arm-gnueabihf": "20.7.2",
-    "@nx/nx-linux-arm64-gnu": "20.7.2",
-    "@nx/nx-linux-arm64-musl": "20.7.2",
-    "@nx/nx-linux-x64-gnu": "20.7.2",
-    "@nx/nx-linux-x64-musl": "20.7.2",
-    "@nx/nx-win32-arm64-msvc": "20.7.2",
-    "@nx/nx-win32-x64-msvc": "20.7.2"
+    "@nx/nx-darwin-arm64": "20.8.0-beta.1",
+    "@nx/nx-darwin-x64": "20.8.0-beta.1",
+    "@nx/nx-freebsd-x64": "20.8.0-beta.1",
+    "@nx/nx-linux-arm-gnueabihf": "20.8.0-beta.1",
+    "@nx/nx-linux-arm64-gnu": "20.8.0-beta.1",
+    "@nx/nx-linux-arm64-musl": "20.8.0-beta.1",
+    "@nx/nx-linux-x64-gnu": "20.8.0-beta.1",
+    "@nx/nx-linux-x64-musl": "20.8.0-beta.1",
+    "@nx/nx-win32-arm64-msvc": "20.8.0-beta.1",
+    "@nx/nx-win32-x64-msvc": "20.8.0-beta.1"
   },
   "nx-migrations": {
     "migrations": "./migrations.json",

package/release/index.d.ts

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

package/release/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.releaseVersion = exports.releasePublish = exports.releaseChangelog = exports.release = exports.ReleaseClient = void 0;
+exports.VersionActions = exports.releaseVersion = exports.releasePublish = exports.releaseChangelog = exports.release = exports.ReleaseClient = void 0;
 /**
  * @public Programmatic API for nx release
  */
@@ -10,3 +10,4 @@ Object.defineProperty(exports, "release", { enumerable: true, get: function () {
 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; } });
+Object.defineProperty(exports, "VersionActions", { enumerable: true, get: function () { return release_1.VersionActions; } });

package/schemas/nx-schema.json

@@ -684,50 +684,150 @@
     },
     "NxReleaseVersionConfiguration": {
       "type": "object",
-      "properties": {
-        "conventionalCommits": {
-          "type": "boolean",
-          "description": "Shorthand for enabling the current version of projects to be resolved from git tags, and the next version to be determined by analyzing commit messages according to the Conventional Commits specification.",
-          "default": false
-        },
-        "generator": {
-          "type": "string"
-        },
-        "generatorOptions": {
-          "type": "object",
-          "additionalProperties": true
-        },
-        "git": {
-          "$ref": "#/definitions/NxReleaseGitConfiguration"
-        },
-        "preVersionCommand": {
-          "type": "string",
-          "description": "A command to run after validation of nx release configuration, but before versioning begins. Useful 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'."
+      "$comment": "The configuration for versioning is dynamic depending on the value of the useLegacyVersioning property. Through trial and error the best in editor DX seems to come from having the if/else at the top level and explicitly include all possible properties and apply additionalProperties false in each case.",
+      "description": "Configuration for the versioning phase of releases.",
+      "if": {
+        "$comment": "When using the latest versioning implementation a lot of configuration has been able to move directly onto the version property.",
+        "properties": {
+          "useLegacyVersioning": {
+            "const": true
+          }
         }
       },
-      "additionalProperties": false
+      "then": {
+        "properties": {
+          "useLegacyVersioning": {
+            "type": "boolean",
+            "description": "Whether to use the legacy versioning strategy. This value will be true in Nx v20 and false in Nx v21. The legacy versioning implementation will be removed in Nx v22, as will this flag.",
+            "default": true
+          },
+          "conventionalCommits": {
+            "type": "boolean",
+            "description": "Shorthand for enabling the current version of projects to be resolved from git tags, and the next version to be determined by analyzing commit messages according to the Conventional Commits specification.",
+            "default": false
+          },
+          "git": {
+            "$ref": "#/definitions/NxReleaseGitConfiguration"
+          },
+          "preVersionCommand": {
+            "type": "string",
+            "description": "A command to run after validation of nx release configuration, but before versioning begins. Useful 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'."
+          },
+          "generator": {
+            "type": "string",
+            "description": "The generator implementation to use for versioning.",
+            "default": "@nx/js:release-version"
+          },
+          "generatorOptions": {
+            "type": "object",
+            "description": "These options will be passed to the configured \"release.version.generator\" (which will be \"@nx/js:release-version\" if not set explicitly).",
+            "additionalProperties": true
+          }
+        },
+        "additionalProperties": false
+      },
+      "else": {
+        "additionalProperties": false,
+        "properties": {
+          "useLegacyVersioning": {
+            "type": "boolean",
+            "description": "Whether to use the legacy versioning strategy. This value will be true in Nx v20 and false in Nx v21. The legacy versioning implementation will be removed in Nx v22, as will this flag.",
+            "default": true
+          },
+          "conventionalCommits": {
+            "type": "boolean",
+            "description": "Shorthand for enabling the current version of projects to be resolved from git tags, and the next version to be determined by analyzing commit messages according to the Conventional Commits specification.",
+            "default": false
+          },
+          "git": {
+            "$ref": "#/definitions/NxReleaseGitConfiguration"
+          },
+          "preVersionCommand": {
+            "type": "string",
+            "description": "A command to run after validation of nx release configuration, but before versioning begins. Useful 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'."
+          },
+          "specifierSource": {
+            "type": "string",
+            "enum": ["prompt", "conventional-commits", "version-plans"],
+            "default": "prompt",
+            "description": "The source to use for determining the specifier to use when versioning. 'prompt' is the default and will interactively prompt the user for an explicit/imperative specifier. 'conventional-commits' will attempt determine a specifier from commit messages conforming to the Conventional Commits specification. 'version-plans' will determine the specifier from the version plan files available on disk."
+          },
+          "manifestRootsToUpdate": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "A list of directories containing manifest files (such as package.json) to apply updates to when versioning. By default, only the project root will be used, but you could customize this to only version a manifest in a dist directory, or even version multiple manifests in different directories, such as both source and dist."
+          },
+          "currentVersionResolver": {
+            "type": "string",
+            "enum": ["registry", "disk", "git-tag", "none"],
+            "description": "The resolver to use for determining the current version of a project during versioning. This is needed for versioning approaches which involve relatively modifying a current version to arrive at a new version, such as semver bumps like 'patch', 'minor' etc. Using 'none' explicitly declares that the current version is not needed to compute the new version, and should only be used with appropriate version actions implementations that support it."
+          },
+          "currentVersionResolverMetadata": {
+            "type": "object",
+            "additionalProperties": true,
+            "description": "Metadata to provide to the configured currentVersionResolver to help it in determining the current version. What to pass here is specific to each resolver."
+          },
+          "fallbackCurrentVersionResolver": {
+            "type": "string",
+            "enum": ["disk"],
+            "description": "The fallback version resolver to use when the configured currentVersionResolver fails to resolve the current version."
+          },
+          "firstRelease": {
+            "type": "boolean",
+            "description": "Whether or not this is the first release of one of more projects. This removes certain validation checks that are not possible to enforce if the project has never been released before."
+          },
+          "versionPrefix": {
+            "type": "string",
+            "enum": ["auto", "", "~", "^", "="],
+            "default": "auto",
+            "description": "The prefix to use when versioning dependencies. This can be one of the following: auto, '', '~', '^', '=', where auto means the existing prefix will be preserved."
+          },
+          "deleteVersionPlans": {
+            "type": "boolean",
+            "description": "Whether to delete the processed version plans file after versioning is complete. This is false by default because the version plans are also needed for changelog generation.",
+            "default": false
+          },
+          "updateDependents": {
+            "type": "string",
+            "enum": ["never", "auto"],
+            "default": "auto",
+            "description": "When versioning independent projects, this controls whether to update their dependents (i.e. the things that depend on them). 'never' means no dependents will be updated (unless they happen to be versioned directly as well). 'auto' is the default and will cause dependents to be updated (a patch version bump) when a dependency is versioned."
+          },
+          "logUnchangedProjects": {
+            "type": "boolean",
+            "description": "Whether to log projects that have not changed during versioning.",
+            "default": true
+          },
+          "preserveLocalDependencyProtocols": {
+            "type": "boolean",
+            "description": "Whether to preserve local dependency protocols (e.g. file references, or the `workspace:` protocol in package.json files) of local dependencies when updating them during versioning. This was false by default in legacy versioning, but is true by default now.",
+            "default": true
+          },
+          "versionActions": {
+            "type": "string",
+            "description": "The path to the version actions implementation to use for releasing all projects by default. This can also be overridden on the release group and project levels.",
+            "default": "@nx/js/src/release"
+          },
+          "versionActionsOptions": {
+            "type": "object",
+            "description": "The specific options that are defined by each version actions implementation. They will be passed to the version actions implementation when running a release.",
+            "additionalProperties": true
+          }
+        }
+      }
     },
     "NxReleaseGroupVersionConfiguration": {
       "type": "object",
+      "$comment": "We need to improve this configuration definition to be more precise once legacy versioning is removed. Right now it needs to be left open and runtime validation will ensure correct behavior.",
       "properties": {
-        "conventionalCommits": {
-          "type": "boolean",
-          "description": "Shorthand for enabling the current version of projects to be resolved from git tags, and the next version to be determined by analyzing commit messages according to the Conventional Commits specification.",
-          "default": false
-        },
-        "generator": {
-          "type": "string"
-        },
-        "generatorOptions": {
-          "type": "object",
-          "additionalProperties": true
-        },
         "groupPreVersionCommand": {
           "type": "string",
           "description": "A command to run after validation of nx release configuration AND after the release.version.preVersionCommand (if any), but before versioning begins for this specific group. Useful for preparing build artifacts for the group. If --dry-run is passed, the command is still executed, but with the NX_DRY_RUN environment variable set to 'true'."
         }
       },
-      "additionalProperties": false
+      "additionalProperties": true
     },
     "NxReleaseChangelogConfiguration": {
       "type": "object",

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;
@@ -228,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 &&
@@ -259,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);
@@ -296,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
@@ -395,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
@@ -642,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
@@ -900,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 [];
@@ -935,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 & {

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

@@ -289,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 {};