From ed74d5c44140e0f9cb0389de641162e8f6db4487 Mon Sep 17 00:00:00 2001
From: Colin Rotherham <work@colinr.com>
Date: Fri, 1 Dec 2023 17:24:36 +0000
Subject: [PATCH] Always post GitHub issue comments in order

We always want JavaScript and Stylesheets first
---
 .github/workflows/scripts/comments.mjs | 32 ++++++++++++++++++--------
 1 file changed, 22 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/scripts/comments.mjs b/.github/workflows/scripts/comments.mjs
index 961c9694c9..59e1d7ec91 100644
--- a/.github/workflows/scripts/comments.mjs
+++ b/.github/workflows/scripts/comments.mjs
@@ -1,5 +1,5 @@
 import { readFile } from 'node:fs/promises'
-import { join } from 'path'
+import { basename, join } from 'path'
 
 import { getFileSizes } from '@govuk-frontend/lib/files'
 import { getStats, modulePaths } from '@govuk-frontend/stats'
@@ -12,16 +12,28 @@ import { getStats, modulePaths } from '@govuk-frontend/stats'
  * @param {DiffComment[]} diffs
  */
 export async function commentDiffs(githubActionContext, issueNumber, diffs) {
-  // Run the comments in parallel to avoid that an early one failing prevents the others
-  // and use `allSettled` to avoid the promise rejecting on the first failure but wait
-  // for everything to complete
-  const results = await Promise.allSettled(
-    diffs.map((diff) => commentDiff(githubActionContext, issueNumber, diff))
-  )
+  const errors = []
+
+  // Run comments in order, but prevent errors stopping other comments
+  for (const diff of diffs) {
+    try {
+      await commentDiff(githubActionContext, issueNumber, diff)
+    } catch (error) {
+      const filename = basename(diff.path)
+
+      // Defer errors until all comments are attempted
+      errors.push(
+        new Error(`Failed to post GitHub comment for ${filename}`, {
+          cause: error
+        })
+      )
+    }
+  }
 
-  if (results.some((result) => result.status === 'rejected')) {
-    throw new Error('Posting diff comment failed', {
-      cause: results
+  // Throw on any deferred errors above
+  if (errors.length) {
+    throw new Error('Failed to post GitHub comments', {
+      cause: errors
     })
   }
 }