@lage-run/config 0.4.14 → 0.4.16

package/CHANGELOG.json

@@ -2,7 +2,43 @@
   "name": "@lage-run/config",
   "entries": [
     {
-      "date": "Sat, 26 Apr 2025 08:08:22 GMT",
+      "date": "Fri, 01 Aug 2025 08:09:39 GMT",
+      "version": "0.4.16",
+      "tag": "@lage-run/config_v0.4.16",
+      "comments": {
+        "patch": [
+          {
+            "author": "renovate@whitesourcesoftware.com",
+            "package": "@lage-run/config",
+            "commit": "28308e0b441f625fb5a83daabadb55f49b208603",
+            "comment": "Update backfill monorepo"
+          },
+          {
+            "author": "renovate@whitesourcesoftware.com",
+            "package": "@lage-run/config",
+            "commit": "28308e0b441f625fb5a83daabadb55f49b208603",
+            "comment": "Update dependency workspace-tools to v0.38.4"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 29 Apr 2025 08:10:03 GMT",
+      "version": "0.4.15",
+      "tag": "@lage-run/config_v0.4.15",
+      "comments": {
+        "patch": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "@lage-run/config",
+            "commit": "8cd955ef4910abb9fff6f0de40255fe842847a79",
+            "comment": "Make CacheOptions properties optional and document them"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sat, 26 Apr 2025 08:08:38 GMT",
       "version": "0.4.14",
       "tag": "@lage-run/config_v0.4.14",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,29 @@
 # Change Log - @lage-run/config
 
-<!-- This log was last generated on Sat, 26 Apr 2025 08:08:22 GMT and should not be manually modified. -->
+<!-- This log was last generated on Fri, 01 Aug 2025 08:09:39 GMT and should not be manually modified. -->
 
 <!-- Start content -->
 
+## 0.4.16
+
+Fri, 01 Aug 2025 08:09:39 GMT
+
+### Patches
+
+- Update backfill monorepo (renovate@whitesourcesoftware.com)
+- Update dependency workspace-tools to v0.38.4 (renovate@whitesourcesoftware.com)
+
+## 0.4.15
+
+Tue, 29 Apr 2025 08:10:03 GMT
+
+### Patches
+
+- Make CacheOptions properties optional and document them (elcraig@microsoft.com)
+
 ## 0.4.14
 
-Sat, 26 Apr 2025 08:08:22 GMT
+Sat, 26 Apr 2025 08:08:38 GMT
 
 ### Patches
 

package/lib/getMaxWorkersPerTask.js

@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    getMaxWorkersPerTask: function() {
+    get getMaxWorkersPerTask () {
         return getMaxWorkersPerTask;
     },
-    getMaxWorkersPerTaskFromOptions: function() {
+    get getMaxWorkersPerTaskFromOptions () {
         return getMaxWorkersPerTaskFromOptions;
     }
 });

package/lib/getMaxWorkersPerTask.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/getMaxWorkersPerTask.ts"],"sourcesContent":["import type { ConfigOptions } from \"./types/ConfigOptions.js\";\n\nexport function getMaxWorkersPerTask(pipelineConfig: ConfigOptions[\"pipeline\"], concurrency: number) {\n  const maxWorkersPerTask = new Map<string, number>();\n\n  let generalPoolCount = 0;\n  let generatelPoolMaxWorkers = 0;\n\n  let dedicatedPoolCount = 0;\n  let dedicatedPoolMaxWorkers = 0;\n\n  for (const [task, taskConfig] of Object.entries(pipelineConfig)) {\n    if (!Array.isArray(taskConfig) && !task.includes(\"#\")) {\n      const maxWorkerOption: number | undefined = taskConfig.maxWorkers ?? taskConfig.options?.maxWorkers;\n\n      if (typeof maxWorkerOption === \"undefined\") {\n        generalPoolCount++;\n        continue;\n      }\n\n      let maxWorkers = 0;\n\n      if (typeof maxWorkerOption !== \"number\") {\n        throw new Error(`Invalid maxWorkers value: ${maxWorkerOption}`);\n      } else {\n        maxWorkers = maxWorkerOption;\n      }\n\n      maxWorkersPerTask.set(task, maxWorkers);\n      dedicatedPoolCount++;\n      dedicatedPoolMaxWorkers += maxWorkers;\n    }\n  }\n\n  if (dedicatedPoolCount > 0 && generalPoolCount > 0) {\n    const avgMaxWorkers = dedicatedPoolMaxWorkers / dedicatedPoolCount;\n    generatelPoolMaxWorkers = Math.max(1, Math.floor(avgMaxWorkers * generalPoolCount));\n  }\n\n  const grandTotal = dedicatedPoolMaxWorkers + generatelPoolMaxWorkers;\n\n  // try to adjust the maxWorkersPerTask to fit the concurrency\n  if (grandTotal > concurrency) {\n    let newTotal = 0;\n    for (const [task, maxWorkers] of maxWorkersPerTask.entries()) {\n      const newMaxWorkers = Math.max(1, Math.floor((maxWorkers / grandTotal) * concurrency));\n      newTotal += newMaxWorkers;\n      maxWorkersPerTask.set(task, newMaxWorkers);\n    }\n\n    if (newTotal > concurrency) {\n      throw new Error(\n        \"Could not adjust maxWorkers per task to fit the concurrency, try reducing the maxWorkers, or increasing the --concurrency CLI argument, or separate the tasks to be run\"\n      );\n    }\n  }\n\n  return maxWorkersPerTask;\n}\n\nexport function getMaxWorkersPerTaskFromOptions(maxWorkersPerTask: string[]) {\n  return new Map([\n    ...maxWorkersPerTask.map((setting) => {\n      const [task, maxWorkers] = setting.split(/[=:]/);\n      return [task, parseInt(maxWorkers, 10)] as [string, number];\n    }),\n  ]);\n}\n"],"names":["getMaxWorkersPerTask","getMaxWorkersPerTaskFromOptions","pipelineConfig","concurrency","maxWorkersPerTask","Map","generalPoolCount","generatelPoolMaxWorkers","dedicatedPoolCount","dedicatedPoolMaxWorkers","task","taskConfig","Object","entries","Array","isArray","includes","maxWorkerOption","maxWorkers","options","Error","set","avgMaxWorkers","Math","max","floor","grandTotal","newTotal","newMaxWorkers","map","setting","split","parseInt"],"mappings":";;;;;;;;;;;IAEgBA,oBAAoB;eAApBA;;IA0DAC,+BAA+B;eAA/BA;;;AA1DT,SAASD,qBAAqBE,cAAyC,EAAEC,WAAmB;IACjG,MAAMC,oBAAoB,IAAIC;IAE9B,IAAIC,mBAAmB;IACvB,IAAIC,0BAA0B;IAE9B,IAAIC,qBAAqB;IACzB,IAAIC,0BAA0B;IAE9B,KAAK,MAAM,CAACC,MAAMC,WAAW,IAAIC,OAAOC,OAAO,CAACX,gBAAiB;QAC/D,IAAI,CAACY,MAAMC,OAAO,CAACJ,eAAe,CAACD,KAAKM,QAAQ,CAAC,MAAM;YACrD,MAAMC,kBAAsCN,WAAWO,UAAU,IAAIP,WAAWQ,OAAO,EAAED;YAEzF,IAAI,OAAOD,oBAAoB,aAAa;gBAC1CX;gBACA;YACF;YAEA,IAAIY,aAAa;YAEjB,IAAI,OAAOD,oBAAoB,UAAU;gBACvC,MAAM,IAAIG,MAAM,CAAC,0BAA0B,EAAEH,iBAAiB;YAChE,OAAO;gBACLC,aAAaD;YACf;YAEAb,kBAAkBiB,GAAG,CAACX,MAAMQ;YAC5BV;YACAC,2BAA2BS;QAC7B;IACF;IAEA,IAAIV,qBAAqB,KAAKF,mBAAmB,GAAG;QAClD,MAAMgB,gBAAgBb,0BAA0BD;QAChDD,0BAA0BgB,KAAKC,GAAG,CAAC,GAAGD,KAAKE,KAAK,CAACH,gBAAgBhB;IACnE;IAEA,MAAMoB,aAAajB,0BAA0BF;IAE7C,6DAA6D;IAC7D,IAAImB,aAAavB,aAAa;QAC5B,IAAIwB,WAAW;QACf,KAAK,MAAM,CAACjB,MAAMQ,WAAW,IAAId,kBAAkBS,OAAO,GAAI;YAC5D,MAAMe,gBAAgBL,KAAKC,GAAG,CAAC,GAAGD,KAAKE,KAAK,CAAC,AAACP,aAAaQ,aAAcvB;YACzEwB,YAAYC;YACZxB,kBAAkBiB,GAAG,CAACX,MAAMkB;QAC9B;QAEA,IAAID,WAAWxB,aAAa;YAC1B,MAAM,IAAIiB,MACR;QAEJ;IACF;IAEA,OAAOhB;AACT;AAEO,SAASH,gCAAgCG,iBAA2B;IACzE,OAAO,IAAIC,IAAI;WACVD,kBAAkByB,GAAG,CAAC,CAACC;YACxB,MAAM,CAACpB,MAAMQ,WAAW,GAAGY,QAAQC,KAAK,CAAC;YACzC,OAAO;gBAACrB;gBAAMsB,SAASd,YAAY;aAAI;QACzC;KACD;AACH"}
+{"version":3,"sources":["../src/getMaxWorkersPerTask.ts"],"sourcesContent":["import type { ConfigOptions } from \"./types/ConfigOptions.js\";\n\nexport function getMaxWorkersPerTask(pipelineConfig: ConfigOptions[\"pipeline\"], concurrency: number) {\n  const maxWorkersPerTask = new Map<string, number>();\n\n  let generalPoolCount = 0;\n  let generatelPoolMaxWorkers = 0;\n\n  let dedicatedPoolCount = 0;\n  let dedicatedPoolMaxWorkers = 0;\n\n  for (const [task, taskConfig] of Object.entries(pipelineConfig)) {\n    if (!Array.isArray(taskConfig) && !task.includes(\"#\")) {\n      const maxWorkerOption: number | undefined = taskConfig.maxWorkers ?? taskConfig.options?.maxWorkers;\n\n      if (typeof maxWorkerOption === \"undefined\") {\n        generalPoolCount++;\n        continue;\n      }\n\n      let maxWorkers = 0;\n\n      if (typeof maxWorkerOption !== \"number\") {\n        throw new Error(`Invalid maxWorkers value: ${maxWorkerOption}`);\n      } else {\n        maxWorkers = maxWorkerOption;\n      }\n\n      maxWorkersPerTask.set(task, maxWorkers);\n      dedicatedPoolCount++;\n      dedicatedPoolMaxWorkers += maxWorkers;\n    }\n  }\n\n  if (dedicatedPoolCount > 0 && generalPoolCount > 0) {\n    const avgMaxWorkers = dedicatedPoolMaxWorkers / dedicatedPoolCount;\n    generatelPoolMaxWorkers = Math.max(1, Math.floor(avgMaxWorkers * generalPoolCount));\n  }\n\n  const grandTotal = dedicatedPoolMaxWorkers + generatelPoolMaxWorkers;\n\n  // try to adjust the maxWorkersPerTask to fit the concurrency\n  if (grandTotal > concurrency) {\n    let newTotal = 0;\n    for (const [task, maxWorkers] of maxWorkersPerTask.entries()) {\n      const newMaxWorkers = Math.max(1, Math.floor((maxWorkers / grandTotal) * concurrency));\n      newTotal += newMaxWorkers;\n      maxWorkersPerTask.set(task, newMaxWorkers);\n    }\n\n    if (newTotal > concurrency) {\n      throw new Error(\n        \"Could not adjust maxWorkers per task to fit the concurrency, try reducing the maxWorkers, or increasing the --concurrency CLI argument, or separate the tasks to be run\"\n      );\n    }\n  }\n\n  return maxWorkersPerTask;\n}\n\nexport function getMaxWorkersPerTaskFromOptions(maxWorkersPerTask: string[]) {\n  return new Map([\n    ...maxWorkersPerTask.map((setting) => {\n      const [task, maxWorkers] = setting.split(/[=:]/);\n      return [task, parseInt(maxWorkers, 10)] as [string, number];\n    }),\n  ]);\n}\n"],"names":["getMaxWorkersPerTask","getMaxWorkersPerTaskFromOptions","pipelineConfig","concurrency","maxWorkersPerTask","Map","generalPoolCount","generatelPoolMaxWorkers","dedicatedPoolCount","dedicatedPoolMaxWorkers","task","taskConfig","Object","entries","Array","isArray","includes","maxWorkerOption","maxWorkers","options","Error","set","avgMaxWorkers","Math","max","floor","grandTotal","newTotal","newMaxWorkers","map","setting","split","parseInt"],"mappings":";;;;;;;;;;;QAEgBA;eAAAA;;QA0DAC;eAAAA;;;AA1DT,SAASD,qBAAqBE,cAAyC,EAAEC,WAAmB;IACjG,MAAMC,oBAAoB,IAAIC;IAE9B,IAAIC,mBAAmB;IACvB,IAAIC,0BAA0B;IAE9B,IAAIC,qBAAqB;IACzB,IAAIC,0BAA0B;IAE9B,KAAK,MAAM,CAACC,MAAMC,WAAW,IAAIC,OAAOC,OAAO,CAACX,gBAAiB;QAC/D,IAAI,CAACY,MAAMC,OAAO,CAACJ,eAAe,CAACD,KAAKM,QAAQ,CAAC,MAAM;YACrD,MAAMC,kBAAsCN,WAAWO,UAAU,IAAIP,WAAWQ,OAAO,EAAED;YAEzF,IAAI,OAAOD,oBAAoB,aAAa;gBAC1CX;gBACA;YACF;YAEA,IAAIY,aAAa;YAEjB,IAAI,OAAOD,oBAAoB,UAAU;gBACvC,MAAM,IAAIG,MAAM,CAAC,0BAA0B,EAAEH,iBAAiB;YAChE,OAAO;gBACLC,aAAaD;YACf;YAEAb,kBAAkBiB,GAAG,CAACX,MAAMQ;YAC5BV;YACAC,2BAA2BS;QAC7B;IACF;IAEA,IAAIV,qBAAqB,KAAKF,mBAAmB,GAAG;QAClD,MAAMgB,gBAAgBb,0BAA0BD;QAChDD,0BAA0BgB,KAAKC,GAAG,CAAC,GAAGD,KAAKE,KAAK,CAACH,gBAAgBhB;IACnE;IAEA,MAAMoB,aAAajB,0BAA0BF;IAE7C,6DAA6D;IAC7D,IAAImB,aAAavB,aAAa;QAC5B,IAAIwB,WAAW;QACf,KAAK,MAAM,CAACjB,MAAMQ,WAAW,IAAId,kBAAkBS,OAAO,GAAI;YAC5D,MAAMe,gBAAgBL,KAAKC,GAAG,CAAC,GAAGD,KAAKE,KAAK,CAAC,AAACP,aAAaQ,aAAcvB;YACzEwB,YAAYC;YACZxB,kBAAkBiB,GAAG,CAACX,MAAMkB;QAC9B;QAEA,IAAID,WAAWxB,aAAa;YAC1B,MAAM,IAAIiB,MACR;QAEJ;IACF;IAEA,OAAOhB;AACT;AAEO,SAASH,gCAAgCG,iBAA2B;IACzE,OAAO,IAAIC,IAAI;WACVD,kBAAkByB,GAAG,CAAC,CAACC;YACxB,MAAM,CAACpB,MAAMQ,WAAW,GAAGY,QAAQC,KAAK,CAAC;YACzC,OAAO;gBAACrB;gBAAMsB,SAASd,YAAY;aAAI;QACzC;KACD;AACH"}

package/lib/index.js

@@ -5,23 +5,23 @@ Object.defineProperty(exports, "__esModule", {
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
         enumerable: true,
-        get: all[name]
+        get: Object.getOwnPropertyDescriptor(all, name).get
     });
 }
 _export(exports, {
-    getConcurrency: function() {
+    get getConcurrency () {
         return _getConcurrency.getConcurrency;
     },
-    getConfig: function() {
+    get getConfig () {
         return _getConfig.getConfig;
     },
-    getMaxWorkersPerTask: function() {
+    get getMaxWorkersPerTask () {
         return _getMaxWorkersPerTask.getMaxWorkersPerTask;
     },
-    getMaxWorkersPerTaskFromOptions: function() {
+    get getMaxWorkersPerTaskFromOptions () {
         return _getMaxWorkersPerTask.getMaxWorkersPerTaskFromOptions;
     },
-    readConfigFile: function() {
+    get readConfigFile () {
         return _readConfigFile.readConfigFile;
     }
 });

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export { getConfig } from \"./getConfig.js\";\nexport { getConcurrency } from \"./getConcurrency.js\";\nexport { getMaxWorkersPerTask, getMaxWorkersPerTaskFromOptions } from \"./getMaxWorkersPerTask.js\";\nexport { readConfigFile } from \"./readConfigFile.js\";\nexport type { PipelineDefinition } from \"./types/PipelineDefinition.js\";\nexport type { ConfigOptions } from \"./types/ConfigOptions.js\";\nexport type { CacheOptions } from \"./types/CacheOptions.js\";\nexport type { LoggerOptions } from \"./types/LoggerOptions.js\";\nexport type { Priority } from \"./types/Priority.js\";\n"],"names":["getConcurrency","getConfig","getMaxWorkersPerTask","getMaxWorkersPerTaskFromOptions","readConfigFile"],"mappings":";;;;;;;;;;;IACSA,cAAc;eAAdA,8BAAc;;IADdC,SAAS;eAATA,oBAAS;;IAETC,oBAAoB;eAApBA,0CAAoB;;IAAEC,+BAA+B;eAA/BA,qDAA+B;;IACrDC,cAAc;eAAdA,8BAAc;;;2BAHG;gCACK;sCACuC;gCACvC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export { getConfig } from \"./getConfig.js\";\nexport { getConcurrency } from \"./getConcurrency.js\";\nexport { getMaxWorkersPerTask, getMaxWorkersPerTaskFromOptions } from \"./getMaxWorkersPerTask.js\";\nexport { readConfigFile } from \"./readConfigFile.js\";\nexport type { PipelineDefinition } from \"./types/PipelineDefinition.js\";\nexport type { ConfigOptions } from \"./types/ConfigOptions.js\";\nexport type { CacheOptions } from \"./types/CacheOptions.js\";\nexport type { LoggerOptions } from \"./types/LoggerOptions.js\";\nexport type { Priority } from \"./types/Priority.js\";\n"],"names":["getConcurrency","getConfig","getMaxWorkersPerTask","getMaxWorkersPerTaskFromOptions","readConfigFile"],"mappings":";;;;;;;;;;;QACSA;eAAAA,8BAAc;;QADdC;eAAAA,oBAAS;;QAETC;eAAAA,0CAAoB;;QAAEC;eAAAA,qDAA+B;;QACrDC;eAAAA,8BAAc;;;2BAHG;gCACK;sCACuC;gCACvC"}

package/lib/types/CacheOptions.d.ts

@@ -1,10 +1,27 @@
 import type { Config as BackfillCacheOptions, CustomStorageConfig } from "backfill-config";
-export type LageBackfillCacheOptions = Omit<BackfillCacheOptions, "cacheStorageConfig"> & {
-    cacheStorageConfig: Exclude<BackfillCacheOptions["cacheStorageConfig"], CustomStorageConfig>;
-};
-export type CacheOptions = LageBackfillCacheOptions & {
-    environmentGlob: string[];
-    cacheKey: string;
-    writeRemoteCache: boolean;
-    skipLocalCache: boolean;
+export type CacheOptions = Omit<BackfillCacheOptions, "cacheStorageConfig"> & {
+    /**
+     * Use this to specify a remote cache provider such as `'azure-blob'`.
+     * @see https://github.com/microsoft/backfill#configuration
+     */
+    cacheStorageConfig?: Exclude<BackfillCacheOptions["cacheStorageConfig"], CustomStorageConfig>;
+    /**
+     * Whether to write to the remote cache - useful for continuous integration systems to provide build-over-build cache.
+     * It is recommended to turn this OFF for local development, turning remote cache to be a build acceleration through remote cache downloads.
+     */
+    writeRemoteCache?: boolean;
+    /**
+     * Skips local cache entirely - useful for continous integration systems that only relies on a remote cache.
+     */
+    skipLocalCache?: boolean;
+    /**
+     * A list of globs to match files whose contents will determine the cache key in addition to the package file contents
+     * The globs are relative to the root of the project.
+     */
+    environmentGlob?: string[];
+    /**
+     * The cache key is a custom string that will be concatenated with the package file contents and the environment glob contents
+     * to generate the cache key.
+     */
+    cacheKey?: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lage-run/config",
-  "version": "0.4.14",
+  "version": "0.4.16",
   "description": "Config management for Lage",
   "repository": {
     "type": "git",
@@ -18,11 +18,11 @@
   },
   "dependencies": {
     "@lage-run/logger": "^1.3.1",
-    "@lage-run/runners": "^1.2.2",
-    "@lage-run/target-graph": "^0.11.2",
-    "backfill-config": "6.6.0",
+    "@lage-run/runners": "^1.2.3",
+    "@lage-run/target-graph": "^0.11.3",
+    "backfill-config": "6.6.1",
     "cosmiconfig": "7.1.0",
-    "workspace-tools": "0.38.3"
+    "workspace-tools": "0.38.4"
   },
   "devDependencies": {
     "@lage-run/monorepo-scripts": "^1.0.0"