nx 20.0.0-canary.20241002-1d10a19 → 20.0.0-canary.20241003-84a5c7a

package/.eslintrc.json

@@ -9,8 +9,18 @@
         "no-restricted-imports": [
           "error",
           {
-            "name": "fs-extra",
-            "message": "Please use equivalent utilities from `node:fs` instead."
+            "paths": [
+              {
+                "name": "fs-extra",
+                "message": "Please use equivalent utilities from `node:fs` instead."
+              }
+            ],
+            "patterns": [
+              {
+                "group": ["**/devkit-exports"],
+                "message": "Do not import from devkit-exports from the nx package"
+              }
+            ]
           }
         ]
       }

package/migrations.json

@@ -1,42 +1,5 @@
 {
   "generators": {
-    "16.0.0-remove-nrwl-cli": {
-      "cli": "nx",
-      "version": "16.0.0-beta.0",
-      "description": "Remove @nrwl/cli.",
-      "implementation": "./src/migrations/update-16-0-0/remove-nrwl-cli"
-    },
-    "16.0.0-tokens-for-depends-on": {
-      "cli": "nx",
-      "version": "16.0.0-beta.9",
-      "description": "Replace `dependsOn.projects` and `inputs` definitions with new configuration format.",
-      "implementation": "./src/migrations/update-16-0-0/update-depends-on-to-tokens"
-    },
-    "16.0.0-update-nx-cloud-runner": {
-      "cli": "nx",
-      "version": "16.0.0-beta.0",
-      "description": "Replace @nrwl/nx-cloud with nx-cloud",
-      "implementation": "./src/migrations/update-16-0-0/update-nx-cloud-runner"
-    },
-    "16.2.0-remove-output-path-from-run-commands": {
-      "cli": "nx",
-      "version": "16.2.0-beta.0",
-      "description": "Remove outputPath from run commands",
-      "implementation": "./src/migrations/update-16-2-0/remove-run-commands-output-path"
-    },
-    "16.6.0-prefix-outputs": {
-      "cli": "nx",
-      "version": "16.6.0-beta.6",
-      "description": "Prefix outputs with {workspaceRoot}/{projectRoot} if needed",
-      "implementation": "./src/migrations/update-15-0-0/prefix-outputs"
-    },
-    "16.8.0-escape-dollar-sign-env": {
-      "cli": "nx",
-      "version": "16.8.0-beta.3",
-      "description": "Escape $ in env variables",
-      "implementation": "./src/migrations/update-16-8-0/escape-dollar-sign-env-variables",
-      "x-repair-skip": true
-    },
     "17.0.0-move-cache-directory": {
       "cli": "nx",
       "version": "17.0.0-beta.1",

package/package.json

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

package/release/changelog-renderer/index.d.ts

@@ -1,15 +1,13 @@
 import { ChangelogChange } from '../../src/command-line/release/changelog';
 import { NxReleaseConfig } from '../../src/command-line/release/config/config';
-import { GitCommit } from '../../src/command-line/release/utils/git';
-import { GithubRepoData, RepoSlug } from '../../src/command-line/release/utils/github';
-import type { ProjectGraph } from '../../src/config/project-graph';
+import { GithubRepoData } from '../../src/command-line/release/utils/github';
 /**
  * The ChangelogRenderOptions are specific to each ChangelogRenderer implementation, and are taken
  * from the user's nx.json configuration and passed as is into the ChangelogRenderer function.
  */
 export type ChangelogRenderOptions = Record<string, unknown>;
 /**
- * When versioning projects independently and enabling `"updateDependents": "always"`, there could
+ * When versioning projects independently and enabling `"updateDependents": "auto"`, there could
  * be additional dependency bump information that is not captured in the commit data, but that nevertheless
  * should be included in the rendered changelog.
  */
@@ -17,34 +15,6 @@ export type DependencyBump = {
     dependencyName: string;
     newVersion: string;
 };
-/**
- * A ChangelogRenderer function takes in the extracted commits and other relevant metadata
- * and returns a string, or a Promise of a string of changelog contents (usually markdown).
- *
- * @param {Object} config The configuration object for the ChangelogRenderer
- * @param {ProjectGraph} config.projectGraph The project graph for the workspace
- * @param {GitCommit[]} config.commits DEPRECATED [Use 'config.changes' instead] - The collection of extracted commits to generate a changelog for
- * @param {ChangelogChange[]} config.changes The collection of changes to show in the changelog
- * @param {string} config.releaseVersion The version that is being released
- * @param {string | null} config.project The name of specific project to generate a changelog for, or `null` if the overall workspace changelog
- * @param {string | false} config.entryWhenNoChanges The (already interpolated) string to use as the changelog entry when there are no changes, or `false` if no entry should be generated
- * @param {ChangelogRenderOptions} config.changelogRenderOptions The options specific to the ChangelogRenderer implementation
- * @param {DependencyBump[]} config.dependencyBumps Optional list of additional dependency bumps that occurred as part of the release, outside of the commit data
- * @param {GithubRepoData} config.repoData Resolved data for the current GitHub repository
- */
-export type ChangelogRenderer = (config: {
-    projectGraph: ProjectGraph;
-    commits?: GitCommit[];
-    changes?: ChangelogChange[];
-    releaseVersion: string;
-    project: string | null;
-    entryWhenNoChanges: string | false;
-    changelogRenderOptions: DefaultChangelogRenderOptions;
-    dependencyBumps?: DependencyBump[];
-    repoSlug?: RepoSlug;
-    repoData?: GithubRepoData;
-    conventionalCommitsConfig: NxReleaseConfig['conventionalCommits'] | null;
-}) => Promise<string> | string;
 /**
  * The specific options available to the default implementation of the ChangelogRenderer that nx exports
  * for the common case.
@@ -72,9 +42,61 @@ export interface DefaultChangelogRenderOptions extends ChangelogRenderOptions {
      */
     versionTitleDate?: boolean;
 }
-/**
- * The default ChangelogRenderer implementation that nx exports for the common case of generating markdown
- * from the given commits and other metadata.
- */
-declare const defaultChangelogRenderer: ChangelogRenderer;
-export default defaultChangelogRenderer;
+export default class DefaultChangelogRenderer {
+    protected changes: ChangelogChange[];
+    protected changelogEntryVersion: string;
+    protected project: string | null;
+    protected entryWhenNoChanges: string | false;
+    protected changelogRenderOptions: DefaultChangelogRenderOptions;
+    protected isVersionPlans: boolean;
+    protected dependencyBumps?: DependencyBump[];
+    protected repoData?: GithubRepoData;
+    protected conventionalCommitsConfig: NxReleaseConfig['conventionalCommits'] | null;
+    protected relevantChanges: ChangelogChange[];
+    protected breakingChanges: string[];
+    protected additionalChangesForAuthorsSection: ChangelogChange[];
+    /**
+     * A ChangelogRenderer class takes in the determined changes and other relevant metadata
+     * and returns a string, or a Promise of a string of changelog contents (usually markdown).
+     *
+     * @param {Object} config The configuration object for the ChangelogRenderer
+     * @param {ChangelogChange[]} config.changes The collection of changes to show in the changelog
+     * @param {string} config.changelogEntryVersion The version for which we are rendering the current changelog entry
+     * @param {string | null} config.project The name of specific project to generate a changelog entry for, or `null` if the overall workspace changelog
+     * @param {string | false} config.entryWhenNoChanges The (already interpolated) string to use as the changelog entry when there are no changes, or `false` if no entry should be generated
+     * @param {boolean} config.isVersionPlans Whether or not Nx release version plans are the source of truth for the changelog entry
+     * @param {ChangelogRenderOptions} config.changelogRenderOptions The options specific to the ChangelogRenderer implementation
+     * @param {DependencyBump[]} config.dependencyBumps Optional list of additional dependency bumps that occurred as part of the release, outside of the change data
+     * @param {GithubRepoData} config.repoData Resolved data for the current GitHub repository
+     * @param {NxReleaseConfig['conventionalCommits'] | null} config.conventionalCommitsConfig The configuration for conventional commits, or null if version plans are being used
+     */
+    constructor(config: {
+        changes: ChangelogChange[];
+        changelogEntryVersion: string;
+        project: string | null;
+        entryWhenNoChanges: string | false;
+        isVersionPlans: boolean;
+        changelogRenderOptions: DefaultChangelogRenderOptions;
+        dependencyBumps?: DependencyBump[];
+        repoData?: GithubRepoData;
+        conventionalCommitsConfig: NxReleaseConfig['conventionalCommits'] | null;
+    });
+    protected filterChanges(changes: ChangelogChange[], project: string | null): ChangelogChange[];
+    render(): Promise<string>;
+    protected preprocessChanges(): void;
+    protected shouldRenderEmptyEntry(): boolean;
+    protected renderEmptyEntry(): string;
+    protected renderVersionTitle(): string;
+    protected renderChangesByType(): string[];
+    protected hasBreakingChanges(): boolean;
+    protected renderBreakingChanges(): string[];
+    protected hasDependencyBumps(): boolean;
+    protected renderDependencyBumps(): string[];
+    protected shouldRenderAuthors(): boolean;
+    protected renderAuthors(): Promise<string[]>;
+    protected formatChange(change: ChangelogChange): string;
+    protected groupChangesByType(): Record<string, ChangelogChange[]>;
+    protected groupChangesByScope(changes: ChangelogChange[]): Record<string, ChangelogChange[]>;
+    protected extractBreakingChangeExplanation(message: string): string | null;
+    protected formatName(name?: string): string;
+}