Add env var alternative to dependency-caching input

github · Oct 29, 2024 · 1338dbc · 1338dbc
1 parent f3714ae
commit 1338dbc
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 4 deletions.
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/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/src/environment.ts b/src/environment.ts
@@ -98,4 +98,11 @@ export enum EnvVar {
    * We check this later to ensure that it hasn't been tampered with by a late e.g. `setup-go` step.
    */
   GO_BINARY_LOCATION = "CODEQL_ACTION_GO_BINARY",
+
+  /**
+   * Used as an alternative to the `dependency-caching` input for the `init` Action.
+   * Useful for experiments where it is easier to set an environment variable than
+   * change the inputs to the Action.
+   */
+  DEPENDENCY_CACHING = "CODEQL_ACTION_DEPENDENCY_CACHING",
 }
diff --git a/src/init-action.ts b/src/init-action.ts
@@ -727,7 +727,9 @@ async function recordZstdAvailability(
 /** Determines whether dependency caching is enabled. */
 function getDependencyCachingEnabled(): boolean {
   // If the workflow specified something always respect that
-  const dependencyCaching = getOptionalInput("dependency-caching");
+  const dependencyCaching =
+    getOptionalInput("dependency-caching") ||
+    process.env[EnvVar.DEPENDENCY_CACHING];
   if (dependencyCaching !== undefined) return dependencyCaching === "true";
 
   // On self-hosted runners which may have dependencies installed centrally, disable caching by default