Merge pull request #2161 from github/henrymercer/path-filter-warning-cli

Only warn about path filters in the Action if the CLI doesn't already warn
github · Feb 27, 2024 · 17c5ab2 · 17c5ab2
2 parents 25d334f + eb991df
commit 17c5ab2
Show file tree

Hide file tree

Showing 9 changed files with 55 additions and 35 deletions.
diff --git a/lib/init-action.js b/lib/init-action.js
diff --git a/lib/init-action.js.map b/lib/init-action.js.map
diff --git a/lib/init.js b/lib/init.js
diff --git a/lib/init.js.map b/lib/init.js.map
diff --git a/lib/tools-features.js b/lib/tools-features.js
diff --git a/lib/tools-features.js.map b/lib/tools-features.js.map
diff --git a/src/init-action.ts b/src/init-action.ts
@@ -262,33 +262,38 @@ async function run() {
     }
     core.endGroup();
 
-    config = await initConfig({
-      languagesInput: getOptionalInput("languages"),
-      queriesInput: getOptionalInput("queries"),
-      packsInput: getOptionalInput("packs"),
-      buildModeInput: getOptionalInput("build-mode"),
-      configFile: getOptionalInput("config-file"),
-      dbLocation: getOptionalInput("db-location"),
-      configInput: getOptionalInput("config"),
-      trapCachingEnabled: getTrapCachingEnabled(),
-      // Debug mode is enabled if:
-      // - The `init` Action is passed `debug: true`.
-      // - Actions step debugging is enabled (e.g. by [enabling debug logging for a rerun](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-all-the-jobs-in-a-workflow),
-      //   or by setting the `ACTIONS_STEP_DEBUG` secret to `true`).
-      debugMode: getOptionalInput("debug") === "true" || core.isDebug(),
-      debugArtifactName:
-        getOptionalInput("debug-artifact-name") || DEFAULT_DEBUG_ARTIFACT_NAME,
-      debugDatabaseName:
-        getOptionalInput("debug-database-name") || DEFAULT_DEBUG_DATABASE_NAME,
-      repository: repositoryNwo,
-      tempDir: getTemporaryDirectory(),
+    config = await initConfig(
+      {
+        languagesInput: getOptionalInput("languages"),
+        queriesInput: getOptionalInput("queries"),
+        packsInput: getOptionalInput("packs"),
+        buildModeInput: getOptionalInput("build-mode"),
+        configFile: getOptionalInput("config-file"),
+        dbLocation: getOptionalInput("db-location"),
+        configInput: getOptionalInput("config"),
+        trapCachingEnabled: getTrapCachingEnabled(),
+        // Debug mode is enabled if:
+        // - The `init` Action is passed `debug: true`.
+        // - Actions step debugging is enabled (e.g. by [enabling debug logging for a rerun](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-all-the-jobs-in-a-workflow),
+        //   or by setting the `ACTIONS_STEP_DEBUG` secret to `true`).
+        debugMode: getOptionalInput("debug") === "true" || core.isDebug(),
+        debugArtifactName:
+          getOptionalInput("debug-artifact-name") ||
+          DEFAULT_DEBUG_ARTIFACT_NAME,
+        debugDatabaseName:
+          getOptionalInput("debug-database-name") ||
+          DEFAULT_DEBUG_DATABASE_NAME,
+        repository: repositoryNwo,
+        tempDir: getTemporaryDirectory(),
+        codeql,
+        workspacePath: getRequiredEnvParam("GITHUB_WORKSPACE"),
+        githubVersion: gitHubVersion,
+        apiDetails,
+        features,
+        logger,
+      },
       codeql,
-      workspacePath: getRequiredEnvParam("GITHUB_WORKSPACE"),
-      githubVersion: gitHubVersion,
-      apiDetails,
-      features,
-      logger,
-    });
+    );
 
     await checkInstallPython311(config.languages, codeql);
 

diff --git a/src/init.ts b/src/init.ts
@@ -11,6 +11,7 @@ import { CodeQLDefaultVersionInfo } from "./feature-flags";
 import { Language, isScannedLanguage } from "./languages";
 import { Logger } from "./logging";
 import { ToolsSource } from "./setup-codeql";
+import { ToolsFeature } from "./tools-features";
 import { TracerConfig, getCombinedTracerConfig } from "./tracer-config";
 import * as util from "./util";
 
@@ -45,11 +46,18 @@ export async function initCodeQL(
 
 export async function initConfig(
   inputs: configUtils.InitConfigInputs,
+  codeql: CodeQL,
 ): Promise<configUtils.Config> {
   const logger = inputs.logger;
   logger.startGroup("Load language configuration");
   const config = await configUtils.initConfig(inputs);
-  printPathFiltersWarning(config, logger);
+  if (
+    !(await codeql.supportsFeature(
+      ToolsFeature.InformsAboutUnsupportedPathFilters,
+    ))
+  ) {
+    printPathFiltersWarning(config, logger);
+  }
   logger.endGroup();
   return config;
 }

diff --git a/src/tools-features.ts b/src/tools-features.ts
@@ -3,6 +3,7 @@ import type { VersionInfo } from "./codeql";
 export enum ToolsFeature {
   BuildModeOption = "buildModeOption",
   IndirectTracingSupportsStaticBinaries = "indirectTracingSupportsStaticBinaries",
+  InformsAboutUnsupportedPathFilters = "informsAboutUnsupportedPathFilters",
   SetsCodeqlRunnerEnvVar = "setsCodeqlRunnerEnvVar",
   TraceCommandUseBuildMode = "traceCommandUseBuildMode",
 }