nx 17.2.4 → 17.2.6

package/changelog-renderer/index.js

@@ -25,7 +25,20 @@ const defaultChangelogRenderer = async ({ projectGraph, commits, releaseVersion,
         test: { title: '✅ Tests' },
         style: { title: '🎨 Styles' },
         ci: { title: '🤖 CI' },
+        revert: { title: '⏪ Revert' },
     };
+    // If the current range of commits contains both a commit and its revert, we strip them both from the final list
+    for (const commit of commits) {
+        if (commit.type === 'revert') {
+            for (const revertedHash of commit.revertedHashes) {
+                const revertedCommit = commits.find((c) => revertedHash.startsWith(c.shortHash));
+                if (revertedCommit) {
+                    commits.splice(commits.indexOf(revertedCommit), 1);
+                    commits.splice(commits.indexOf(commit), 1);
+                }
+            }
+        }
+    }
     // workspace root level changelog
     if (project === null) {
         // No changes for the workspace
@@ -57,7 +70,10 @@ const defaultChangelogRenderer = async ({ projectGraph, commits, releaseVersion,
                     const line = formatCommit(commit, repoSlug);
                     markdownLines.push(line);
                     if (commit.isBreaking) {
-                        breakingChanges.push(line);
+                        const breakingChangeExplanation = extractBreakingChangeExplanation(commit.body);
+                        breakingChanges.push(breakingChangeExplanation
+                            ? `- ${commit.scope ? `**${commit.scope.trim()}:** ` : ''}${breakingChangeExplanation}`
+                            : line);
                     }
                 }
             }
@@ -88,7 +104,10 @@ const defaultChangelogRenderer = async ({ projectGraph, commits, releaseVersion,
                 const line = formatCommit(commit, repoSlug);
                 markdownLines.push(line + '\n');
                 if (commit.isBreaking) {
-                    breakingChanges.push(line);
+                    const breakingChangeExplanation = extractBreakingChangeExplanation(commit.body);
+                    breakingChanges.push(breakingChangeExplanation
+                        ? `- ${commit.scope ? `**${commit.scope.trim()}:** ` : ''}${breakingChangeExplanation}`
+                        : line);
                 }
             }
         }
@@ -173,11 +192,32 @@ function groupBy(items, key) {
 }
 function formatCommit(commit, repoSlug) {
     let commitLine = '- ' +
-        (commit.scope ? `**${commit.scope.trim()}:** ` : '') +
         (commit.isBreaking ? '⚠️  ' : '') +
+        (commit.scope ? `**${commit.scope.trim()}:** ` : '') +
         commit.description;
     if (repoSlug) {
         commitLine += (0, github_1.formatReferences)(commit.references, repoSlug);
     }
     return commitLine;
 }
+/**
+ * It is common to add further information about a breaking change in the commit body,
+ * and it is naturally that information that should be included in the BREAKING CHANGES
+ * section of changelog, rather than repeating the commit title/description.
+ */
+function extractBreakingChangeExplanation(message) {
+    const breakingChangeIdentifier = 'BREAKING CHANGE:';
+    const startIndex = message.indexOf(breakingChangeIdentifier);
+    if (startIndex === -1) {
+        // "BREAKING CHANGE:" not found in the message
+        return null;
+    }
+    const startOfBreakingChange = startIndex + breakingChangeIdentifier.length;
+    const endOfBreakingChange = message.indexOf('\n', startOfBreakingChange);
+    if (endOfBreakingChange === -1) {
+        // No newline character found, extract till the end of the message
+        return message.substring(startOfBreakingChange).trim();
+    }
+    // Extract and return the breaking change message
+    return message.substring(startOfBreakingChange, endOfBreakingChange).trim();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nx",
-  "version": "17.2.4",
+  "version": "17.2.6",
   "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.4"
+    "@nrwl/tao": "17.2.6"
   },
   "peerDependencies": {
     "@swc-node/register": "^1.6.7",
@@ -81,16 +81,16 @@
     }
   },
   "optionalDependencies": {
-    "@nx/nx-darwin-x64": "17.2.4",
-    "@nx/nx-darwin-arm64": "17.2.4",
-    "@nx/nx-linux-x64-gnu": "17.2.4",
-    "@nx/nx-linux-x64-musl": "17.2.4",
-    "@nx/nx-win32-x64-msvc": "17.2.4",
-    "@nx/nx-linux-arm64-gnu": "17.2.4",
-    "@nx/nx-linux-arm64-musl": "17.2.4",
-    "@nx/nx-linux-arm-gnueabihf": "17.2.4",
-    "@nx/nx-win32-arm64-msvc": "17.2.4",
-    "@nx/nx-freebsd-x64": "17.2.4"
+    "@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-migrations": {
     "migrations": "./migrations.json",

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

@@ -20,6 +20,7 @@ export interface GitCommit extends RawGitCommit {
     authors: GitCommitAuthor[];
     isBreaking: boolean;
     affectedFiles: string[];
+    revertedHashes: string[];
 }
 export declare function getLatestGitTagForPattern(releaseTagPattern: string, additionalInterpolationData?: {}): Promise<{
     tag: string;

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

@@ -181,14 +181,14 @@ const CoAuthoredByRegex = /co-authored-by:\s*(?<name>.+)(<(?<email>.+)>)/gim;
 const PullRequestRE = /\([ a-z]*(#\d+)\s*\)/gm;
 const IssueRE = /(#\d+)/gm;
 const ChangedFileRegex = /(A|M|D|R\d*|C\d*)\t([^\t\n]*)\t?(.*)?/gm;
+const RevertHashRE = /This reverts commit (?<hash>[\da-f]{40})./gm;
 function parseGitCommit(commit) {
     const match = commit.message.match(ConventionalCommitRegex);
     if (!match) {
         return null;
     }
-    const type = match.groups.type;
     const scope = match.groups.scope || '';
-    const isBreaking = Boolean(match.groups.breaking);
+    const isBreaking = Boolean(match.groups.breaking) || commit.body.includes('BREAKING CHANGE:');
     let description = match.groups.description;
     // Extract references from message
     const references = [];
@@ -203,6 +203,17 @@ function parseGitCommit(commit) {
     references.push({ value: commit.shortHash, type: 'hash' });
     // Remove references and normalize
     description = description.replace(PullRequestRE, '').trim();
+    let type = match.groups.type;
+    // Extract any reverted hashes, if applicable
+    const revertedHashes = [];
+    const matchedHashes = commit.body.matchAll(RevertHashRE);
+    for (const matchedHash of matchedHashes) {
+        revertedHashes.push(matchedHash.groups.hash);
+    }
+    if (revertedHashes.length) {
+        type = 'revert';
+        description = commit.message;
+    }
     // Find all authors
     const authors = [commit.author];
     for (const match of commit.body.matchAll(CoAuthoredByRegex)) {
@@ -223,6 +234,7 @@ function parseGitCommit(commit) {
         scope,
         references,
         isBreaking,
+        revertedHashes,
         affectedFiles,
     };
 }