Add user error for gracefully running out of memory

As opposed to being killed by the JVM, which is a failure not a user error.
github · May 8, 2024 · 45fb58a · 45fb58a
1 parent ec11790
commit 45fb58a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/lib/cli-errors.js b/lib/cli-errors.js
diff --git a/lib/cli-errors.js.map b/lib/cli-errors.js.map
diff --git a/src/cli-errors.ts b/src/cli-errors.ts
@@ -122,6 +122,7 @@ function ensureEndsInPeriod(text: string): string {
 /** Error messages from the CLI that we consider configuration errors and handle specially. */
 export enum CliConfigErrorCategory {
   ExternalRepositoryCloneFailed = "ExternalRepositoryCloneFailed",
+  GracefulOutOfMemory = "GracefulOutOfMemory",
   GradleBuildFailed = "GradleBuildFailed",
   IncompatibleWithActionVersion = "IncompatibleWithActionVersion",
   InitCalledTwice = "InitCalledTwice",
@@ -157,6 +158,9 @@ export const cliErrorsConfig: Record<
       new RegExp("Failed to clone external Git repository"),
     ],
   },
+  [CliConfigErrorCategory.GracefulOutOfMemory]: {
+    cliErrorMessageCandidates: [new RegExp("CodeQL is out of memory.")],
+  },
   [CliConfigErrorCategory.GradleBuildFailed]: {
     cliErrorMessageCandidates: [
       new RegExp("[autobuild] FAILURE: Build failed with an exception."),