Add environment variable for custom dependency cache prefix

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

Hide file tree

Showing 6 changed files with 29 additions and 4 deletions.
diff --git a/lib/dependency-caching.js b/lib/dependency-caching.js
diff --git a/lib/dependency-caching.js.map b/lib/dependency-caching.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/dependency-caching.ts b/src/dependency-caching.ts
@@ -9,6 +9,7 @@ import { Config } from "./config-utils";
 import { Language } from "./languages";
 import { Logger } from "./logging";
 import { getRequiredEnvParam } from "./util";
+import { EnvVar } from "./environment";
 
 /**
  * Caching configuration for a particular language.
@@ -197,5 +198,12 @@ async function cacheKey(
  */
 async function cachePrefix(language: Language): Promise<string> {
   const runnerOs = getRequiredEnvParam("RUNNER_OS");
-  return `${CODEQL_DEPENDENCY_CACHE_PREFIX}-${CODEQL_DEPENDENCY_CACHE_VERSION}-${runnerOs}-${language}-`;
+  const customPrefix = process.env[EnvVar.DEPENDENCY_CACHING_PREFIX];
+  let prefix = CODEQL_DEPENDENCY_CACHE_PREFIX;
+
+  if (customPrefix !== undefined && customPrefix.length > 0) {
+    prefix = `${prefix}-${customPrefix}`;
+  }
+
+  return `${prefix}-${CODEQL_DEPENDENCY_CACHE_VERSION}-${runnerOs}-${language}-`;
 }
diff --git a/src/environment.ts b/src/environment.ts
@@ -105,4 +105,10 @@ export enum EnvVar {
    * change the inputs to the Action.
    */
   DEPENDENCY_CACHING = "CODEQL_ACTION_DEPENDENCY_CACHING",
+
+  /**
+   * An optional string to add into the cache key used by dependency caching.
+   * Useful for testing purposes where multiple caches may be stored in the same repository.
+   */
+  DEPENDENCY_CACHING_PREFIX = "CODEQL_ACTION_DEPENDENCY_CACHE_PREFIX",
 }