fix(ng-dev): properly remove reverted commits during release note generation

When we are compiling the list of the commits that should be included for release notes, we now remove
the commits which have been identified as reverted based on later commits in the release commmits range.

Author: josephperrott

.github/local-actions/branch-manager/main.js

@@ -19,6 +19,8 @@ export interface Commit {
   fullText: string;
   /** The header line of the commit, will be used in the changelog entries. */
   header: string;
+  /** The original header line of the commit, before stripping away fixup, squash, etc. */
+  originalHeader: string;
   /** The full body of the commit, not including the footer. */
   body: string;
   /** The footer of the commit, containing issue references and note sections. */
@@ -114,8 +116,8 @@ const parseOptions: ParserOptions = {
   noteKeywords: [NoteSections.BREAKING_CHANGE, NoteSections.DEPRECATED],
   notesPattern: (keywords: string) => new RegExp(`^\\s*(${keywords}): ?(.*)`),
 };
-
-let commitParser: CommitParser | undefined;
+/** Instance of the commit parser to parse raw commits. */
+const commitParser = new CommitParser(parseOptions);
 
 /** Parse a commit message into its composite parts. */
 export const parseCommitMessage: (fullText: string) => Commit = parseInternal;
@@ -128,21 +130,18 @@ function parseInternal(fullText: string): Commit;
 function parseInternal(fullText: Buffer): CommitFromGitLog;
 function parseInternal(fullText: string | Buffer): CommitFromGitLog | Commit {
   // Ensure the fullText symbol is a `string`, even if a Buffer was provided.
-  fullText = fullText.toString();
-  /** The commit message text with the fixup and squash markers stripped out. */
-  const strippedCommitMsg = fullText
-    .replace(FIXUP_PREFIX_RE, '')
-    .replace(SQUASH_PREFIX_RE, '')
-    .replace(REVERT_PREFIX_RE, '');
-
-  commitParser ??= new CommitParser(parseOptions);
-
+  fullText = fullText.toString().trim();
   /** The initially parsed commit. */
-  const commit = commitParser.parse(strippedCommitMsg);
+  const commit = commitParser.parse(fullText);
   /** A list of breaking change notes from the commit. */
   const breakingChanges: CommitNote[] = [];
   /** A list of deprecation notes from the commit. */
   const deprecations: CommitNote[] = [];
+  /** The extracted header after stripping away fixup, squash, etc. */
+  const header = (commit.header || '')
+    .replace(FIXUP_PREFIX_RE, '')
+    .replace(SQUASH_PREFIX_RE, '')
+    .replace(REVERT_PREFIX_RE, '');
 
   // Extract the commit message notes by marked types into their respective lists.
   for (const note of commit.notes) {
@@ -160,9 +159,10 @@ function parseInternal(fullText: string | Buffer): CommitFromGitLog | Commit {
     fullText,
     breakingChanges,
     deprecations,
+    header,
     body: commit.body || '',
     footer: commit.footer || '',
-    header: commit.header || '',
+    originalHeader: commit.header || '',
     references: commit.references,
     scope: commit['scope'] || '',
     subject: commit['subject'] || '',

github-actions/pull-request-labeling/main.js

@@ -75,7 +75,7 @@ export function getCommitsForRangeWithDeduping(
 }
 
 /** Fetches commits for the given revision range using `git log`. */
-export function fetchCommitsForRevisionRange(
+function fetchCommitsForRevisionRange(
   client: GitClient,
   revisionRange: string,
 ): CommitFromGitLog[] {
@@ -85,12 +85,28 @@ export function fetchCommitsForRevisionRange(
     `--format=${gitLogFormatForParsing}${splitDelimiter}`,
     revisionRange,
   ]);
+  /** A set of the commits in the provided range. */
+  const commits = new Map<string, CommitFromGitLog>();
 
-  return output.stdout
+  output.stdout
     .split(splitDelimiter)
-    .filter((entry) => !!entry.trim())
-    .map(santizeCommitMessage)
-    .map((entry) => parseCommitFromGitLog(Buffer.from(entry, 'utf-8')));
+    // Reverse the list of commits so that we encounter original commits before revert commits.
+    .reverse()
+    .forEach((entry) => {
+      if (entry.trim() === '') {
+        return;
+      }
+      const commit = parseCommitFromGitLog(Buffer.from(santizeCommitMessage(entry), 'utf-8'));
+      if (commit.isRevert) {
+        commits.delete(commit.originalHeader.match(/^revert:? "(.*)"/i)?.[1] || '');
+      } else {
+        commits.set(commit.header, commit);
+      }
+    });
+
+  // We return an array of the commits, Map preserves the instert order of the values in the Map. The
+  // order is reversed to get back to the expected order.
+  return Array.from(commits.values()).reverse();
 }
 
 /**