Merge pull request #1884 from github/henrymercer/deprecation-warning-for-codeql-2.10.x

Add a deprecation warning for CodeQL 2.10.*
2026-04-13 10:05:50 +00:00 · 2023-09-15 17:47:36 +01:00
parent f3051ed54e a087b01cdd
commit c459726691
4 changed files with 48 additions and 22 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,12 +4,14 @@ See the [releases page](https://github.com/github/codeql-action/releases) for th

 ## [UNRELEASED]

-No user facing changes.
+- Add a deprecation warning for customers using CodeQL version 2.10.4 and earlier. These versions of CodeQL were discontinued on 12 September 2023 alongside GitHub Enterprise Server 3.6, and will be unsupported by the next minor release of the CodeQL Action. [#1884](https://github.com/github/codeql-action/pull/1884)
+  - If you are using one of these versions, please update to CodeQL CLI version 2.10.5 or later. For instance, if you have specified a custom version of the CLI using the 'tools' input to the 'init' Action, you can remove this input to use the default version.
+  - Alternatively, if you want to continue using a version of the CodeQL CLI between 2.9.5 and 2.10.4, you can replace `github/codeql-action/*@v2` by `github/codeql-action/*@v2.21.7` in your code scanning workflow to ensure you continue using this version of the CodeQL Action.
+- Enable the following language aliases when using CodeQL 2.14.4 and later: `c-cpp` for C/C++ analysis, `java-kotlin` for Java/Kotlin analysis, and `javascript-typescript` for JavaScript/TypeScript analysis. [#1883](https://github.com/github/codeql-action/pull/1883)

 ## 2.21.7 - 14 Sep 2023

 - Update default CodeQL bundle version to 2.14.5. [#1882](https://github.com/github/codeql-action/pull/1882)
- Enable the following language aliases when using CodeQL 2.14.4 and later: `c-cpp` for C/C++ analysis, `java-kotlin` for Java/Kotlin analysis, and `javascript-typescript` for JavaScript/TypeScript analysis. [#1883](https://github.com/github/codeql-action/pull/1883)

 ## 2.21.6 - 13 Sep 2023

--- a/lib/codeql.js
+++ b/lib/codeql.js
@@ -66,7 +66,15 @@ const CODEQL_MINIMUM_VERSION = "2.9.4";
 /**
 * This version will shortly become the oldest version of CodeQL that the Action will run with.
 */
-const CODEQL_NEXT_MINIMUM_VERSION = "2.9.4";
+const CODEQL_NEXT_MINIMUM_VERSION = "2.10.5";
+/**
+ * This is the version of GHES that was most recently deprecated.
+ */
+const GHES_VERSION_MOST_RECENTLY_DEPRECATED = "3.6";
+/**
+ * This is the deprecation date for the version of GHES that was most recently deprecated.
+ */
+const GHES_MOST_RECENT_DEPRECATION_DATE = "2023-09-12";
 /**
 * Versions of CodeQL that version-flag certain functionality in the Action.
 * For convenience, please keep these in descending order. Once a version
@@ -673,16 +681,17 @@ async function getCodeQLForCmd(cmd, checkVersion) {
    else if (checkVersion &&
        process.env[environment_1.EnvVar.SUPPRESS_DEPRECATED_SOON_WARNING] !== "true" &&
        !(await util.codeQlVersionAbove(codeql, CODEQL_NEXT_MINIMUM_VERSION))) {
-        core.warning(`CodeQL CLI version ${await codeql.getVersion()} was deprecated on 2023-06-20 alongside ` +
-            "GitHub Enterprise Server 3.5 and will not be supported by the next release of the " +
-            `CodeQL Action. Please update to CodeQL CLI version ${CODEQL_NEXT_MINIMUM_VERSION} or ` +
-            "later. For instance, if you have specified a custom version of the CLI using the " +
-            "'tools' input to the 'init' Action, you can remove this input to use the default " +
-            "version.\n\n" +
+        core.warning(`CodeQL CLI version ${await codeql.getVersion()} was discontinued on ` +
+            `${GHES_MOST_RECENT_DEPRECATION_DATE} alongside GitHub Enterprise Server ` +
+            `${GHES_VERSION_MOST_RECENTLY_DEPRECATED} and will not be supported by the next minor ` +
+            `release of the CodeQL Action. Please update to CodeQL CLI version ` +
+            `${CODEQL_NEXT_MINIMUM_VERSION} or later. For instance, if you have specified a custom ` +
+            "version of the CLI using the 'tools' input to the 'init' Action, you can remove this " +
+            "input to use the default version.\n\n" +
            "Alternatively, if you want to continue using CodeQL CLI version " +
            `${await codeql.getVersion()}, you can replace 'github/codeql-action/*@v2' by ` +
-            "'github/codeql-action/*@v2.20.4' in your code scanning workflow to ensure you continue " +
-            "using this version of the CodeQL Action.");
+            `'github/codeql-action/*@v${(0, actions_util_1.getActionVersion)()}' in your code scanning workflow to ` +
+            "continue using this version of the CodeQL Action.");
        core.exportVariable(environment_1.EnvVar.SUPPRESS_DEPRECATED_SOON_WARNING, "true");
    }
    return codeql;
--- a/lib/codeql.js.map
+++ b/lib/codeql.js.map
--- a/src/codeql.ts
+++ b/src/codeql.ts
@@ -5,7 +5,11 @@ import * as core from "@actions/core";
 import * as toolrunner from "@actions/exec/lib/toolrunner";
 import * as yaml from "js-yaml";

-import { getOptionalInput, isAnalyzingDefaultBranch } from "./actions-util";
+import {
+  getActionVersion,
+  getOptionalInput,
+  isAnalyzingDefaultBranch,
+} from "./actions-util";
 import * as api from "./api-client";
 import type { Config } from "./config-utils";
 import { EnvVar } from "./environment";
@@ -277,7 +281,17 @@ const CODEQL_MINIMUM_VERSION = "2.9.4";
 /**
 * This version will shortly become the oldest version of CodeQL that the Action will run with.
 */
-const CODEQL_NEXT_MINIMUM_VERSION = "2.9.4";
+const CODEQL_NEXT_MINIMUM_VERSION = "2.10.5";
+
+/**
+ * This is the version of GHES that was most recently deprecated.
+ */
+const GHES_VERSION_MOST_RECENTLY_DEPRECATED = "3.6";
+
+/**
+ * This is the deprecation date for the version of GHES that was most recently deprecated.
+ */
+const GHES_MOST_RECENT_DEPRECATION_DATE = "2023-09-12";

 /**
 * Versions of CodeQL that version-flag certain functionality in the Action.
@@ -1101,16 +1115,17 @@ export async function getCodeQLForCmd(
    !(await util.codeQlVersionAbove(codeql, CODEQL_NEXT_MINIMUM_VERSION))
  ) {
    core.warning(
-      `CodeQL CLI version ${await codeql.getVersion()} was deprecated on 2023-06-20 alongside ` +
-        "GitHub Enterprise Server 3.5 and will not be supported by the next release of the " +
-        `CodeQL Action. Please update to CodeQL CLI version ${CODEQL_NEXT_MINIMUM_VERSION} or ` +
-        "later. For instance, if you have specified a custom version of the CLI using the " +
-        "'tools' input to the 'init' Action, you can remove this input to use the default " +
-        "version.\n\n" +
+      `CodeQL CLI version ${await codeql.getVersion()} was discontinued on ` +
+        `${GHES_MOST_RECENT_DEPRECATION_DATE} alongside GitHub Enterprise Server ` +
+        `${GHES_VERSION_MOST_RECENTLY_DEPRECATED} and will not be supported by the next minor ` +
+        `release of the CodeQL Action. Please update to CodeQL CLI version ` +
+        `${CODEQL_NEXT_MINIMUM_VERSION} or later. For instance, if you have specified a custom ` +
+        "version of the CLI using the 'tools' input to the 'init' Action, you can remove this " +
+        "input to use the default version.\n\n" +
        "Alternatively, if you want to continue using CodeQL CLI version " +
        `${await codeql.getVersion()}, you can replace 'github/codeql-action/*@v2' by ` +
-        "'github/codeql-action/*@v2.20.4' in your code scanning workflow to ensure you continue " +
-        "using this version of the CodeQL Action.",
+        `'github/codeql-action/*@v${getActionVersion()}' in your code scanning workflow to ` +
+        "continue using this version of the CodeQL Action.",
    );
    core.exportVariable(EnvVar.SUPPRESS_DEPRECATED_SOON_WARNING, "true");
  }