fix: ignore unreachable PRs when formatting changelogs (#2861)

FuelLabs · Jul 30, 2024 · 6ba4fc9 · 6ba4fc9
1 parent 16ee1bf
commit 6ba4fc9
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/.changeset/twenty-donuts-sin.md b/.changeset/twenty-donuts-sin.md
@@ -0,0 +1,4 @@
+---
+---
+
+fix: ignore unreachable PRs when formatting changelogs
diff --git a/scripts/changeset/get-full-changelog.mts b/scripts/changeset/get-full-changelog.mts
@@ -25,7 +25,7 @@ const prTypes = ["feat", "fix", "refactor", "chore", "docs"];
 async function getChangelogInfo(
   octokit: Octokit,
   changeset: NewChangeset,
-): Promise<ChangelogInfo> {
+): Promise<ChangelogInfo | undefined> {
   const changesetCommit = execSync(
     `git log -n 1 --diff-filter=A --oneline --pretty=format:%H -- ${join(
       process.cwd(),
@@ -50,6 +50,15 @@ async function getChangelogInfo(
     pull_number: prNo!,
   });
 
+  /**
+   * There are special cases that follow a different flow.
+   * e.g. https://github.com/FuelLabs/fuels-ts/commit/16ee1bfe66733551d00f0a76c21e8a09ea33006f.
+   * They should be ignored in the changelogs.
+   */
+  if (title === undefined) {
+    return undefined;
+  }
+
   const prType = title.replace(/(\w+).*/, "$1"); // chore!: add something -> chore
   const isBreaking = title.includes(`${prType}!`);
 
@@ -107,7 +116,7 @@ async function getChangelogs(octokit: Octokit, changesets: NewChangeset[]) {
     ),
   );
 
-  return changelogs.sort(sortChangelogsByPrType);
+  return changelogs.filter((c) => c !== undefined).sort(sortChangelogsByPrType);
 }
 
 function mapPrTypeToTitle(prType: string) {