Only warn once about the CodeQL CLI being unsupported soon

github · Jul 6, 2023 · 6873416 · 6873416
1 parent 3c980c6
commit 6873416
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 2 deletions.
diff --git a/lib/codeql.js b/lib/codeql.js
diff --git a/lib/codeql.js.map b/lib/codeql.js.map
diff --git a/lib/environment.js b/lib/environment.js
diff --git a/lib/environment.js.map b/lib/environment.js.map
diff --git a/src/codeql.ts b/src/codeql.ts
@@ -8,6 +8,7 @@ import * as yaml from "js-yaml";
 import { getOptionalInput } from "./actions-util";
 import * as api from "./api-client";
 import { Config, getGeneratedCodeScanningConfigPath } from "./config-utils";
+import { EnvVar } from "./environment";
 import { errorMatchers } from "./error-matcher";
 import {
   CodeQLDefaultVersionInfo,
@@ -1040,6 +1041,7 @@ export async function getCodeQLForCmd(
     );
   } else if (
     checkVersion &&
+    process.env[EnvVar.SUPPRESS_DEPRECATED_SOON_WARNING] !== "true" &&
     !(await util.codeQlVersionAbove(codeql, CODEQL_NEXT_MINIMUM_VERSION))
   ) {
     core.warning(
@@ -1054,6 +1056,8 @@ export async function getCodeQLForCmd(
         "'github/codeql-action/*@v2.20.4' in your code scanning workflow to ensure you continue " +
         "using this version of the CodeQL Action."
     );
+    process.env[EnvVar.SUPPRESS_DEPRECATED_SOON_WARNING] = "true";
+    core.exportVariable(EnvVar.SUPPRESS_DEPRECATED_SOON_WARNING, "true");
   }
   return codeql;
 }

diff --git a/src/environment.ts b/src/environment.ts
@@ -41,6 +41,9 @@ export enum EnvVar {
 
   ODASA_TRACER_CONFIGURATION = "ODASA_TRACER_CONFIGURATION",
 
+  /** Whether to suppress the warning if the current CLI will soon be unsupported. */
+  SUPPRESS_DEPRECATED_SOON_WARNING = "CODEQL_ACTION_SUPPRESS_DEPRECATED_SOON_WARNING",
+
   /** Used to disable uploading SARIF results or status reports to the GitHub API */
   TEST_MODE = "CODEQL_ACTION_TEST_MODE",