Merge branch 'main' into dependabot/npm_and_yarn/npm-9fb391b1e9

CHANGELOG.md

@@ -6,7 +6,7 @@ Note that the only difference between `v2` and `v3` of the CodeQL Action is the
 
 ## [UNRELEASED]
 
-No user facing changes.
+- Update default CodeQL bundle version to 2.16.4. [#2185](https://github.com/github/codeql-action/pull/2185)
 
 ## 3.24.6 - 29 Feb 2024
 

lib/defaults.json

@@ -1,6 +1,6 @@
 {
-    "bundleVersion": "codeql-bundle-v2.16.3",
-    "cliVersion": "2.16.3",
-    "priorBundleVersion": "codeql-bundle-v2.16.2",
-    "priorCliVersion": "2.16.2"
+    "bundleVersion": "codeql-bundle-v2.16.4",
+    "cliVersion": "2.16.4",
+    "priorBundleVersion": "codeql-bundle-v2.16.3",
+    "priorCliVersion": "2.16.3"
 }

src/codeql.ts

@@ -334,6 +334,11 @@ export const CODEQL_VERSION_ANALYSIS_SUMMARY_V2 = "2.15.0";
  */
 export const CODEQL_VERSION_SUBLANGUAGE_FILE_COVERAGE = "2.15.0";
 
+/**
+ * Versions 2.15.2+ of the CodeQL CLI support the `--sarif-include-query-help` option.
+ */
+const CODEQL_VERSION_INCLUDE_QUERY_HELP = "2.15.2";
+
 /**
  * Set up CodeQL CLI access.
  *
@@ -855,9 +860,9 @@ export async function getCodeQLForCmd(
         "--print-diagnostics-summary",
         "--print-metrics-summary",
         "--sarif-add-baseline-file-info",
-        "--sarif-add-query-help",
-        "--sarif-group-rules-by-pack",
         ...(await getCodeScanningConfigExportArguments(config, this)),
+        "--sarif-group-rules-by-pack",
+        ...(await getCodeScanningQueryHelpArguments(this)),
         ...getExtraOptionsFromEnv(["database", "interpret-results"]),
       ];
       if (automationDetailsId !== undefined) {
@@ -1389,3 +1394,14 @@ async function isSublanguageFileCoverageEnabled(
     ))
   );
 }
+
+async function getCodeScanningQueryHelpArguments(
+  codeql: CodeQL,
+): Promise<string[]> {
+  if (
+    await util.codeQlVersionAbove(codeql, CODEQL_VERSION_INCLUDE_QUERY_HELP)
+  ) {
+    return ["--sarif-include-query-help=always"];
+  }
+  return ["--sarif-add-query-help"];
+}

src/defaults.json

@@ -1,6 +1,6 @@
 {
-  "bundleVersion": "codeql-bundle-v2.16.3",
-  "cliVersion": "2.16.3",
-  "priorBundleVersion": "codeql-bundle-v2.16.2",
-  "priorCliVersion": "2.16.2"
+  "bundleVersion": "codeql-bundle-v2.16.4",
+  "cliVersion": "2.16.4",
+  "priorBundleVersion": "codeql-bundle-v2.16.3",
+  "priorCliVersion": "2.16.3"
 }