@effected/github-actions 0.19.1 → 0.20.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/ToolInstaller.js CHANGED
@@ -96,8 +96,8 @@ const make = Effect.gen(function* () {
96
96
  * installed". Discarding it is what makes an extraction failure unactionable.
97
97
  *
98
98
  * **One spawn, not two — load-bearing**, and why is spelled once in
99
- * `internal/spawn.ts`: the double run failed 5/5 on real Windows runners
100
- * because .NET's `ZipFile.ExtractToDirectory` refuses to overwrite.
99
+ * `internal/spawn.ts`: a second run fails on Windows because .NET's
100
+ * `ZipFile.ExtractToDirectory` refuses to overwrite.
101
101
  */
102
102
  const extractWith = (command, archive) => Effect.gen(function* () {
103
103
  const { output, code } = yield* spawnOnce(spawner, command).pipe(Effect.mapError((cause) => new ToolInstallerError({
@@ -287,7 +287,7 @@ const dies = unstubbed("ToolInstaller.makeTest");
287
287
  * environment because a double has no `ActionEnvironment` to ask. The literal
288
288
  * `/tmp/runner-tool-cache` is what `make`'s `path.join("/tmp", "runner-tool-cache")`
289
289
  * spells on POSIX, which is the only place a test double runs. Test-double
290
- * only; allowlisted as such in `__test__/ambientReads.test.ts`.
290
+ * only.
291
291
  */
292
292
  const testRoot = () => process.env.RUNNER_TOOL_CACHE ?? "/tmp/runner-tool-cache";
293
293
  /**
@@ -323,6 +323,13 @@ const testRoot = () => process.env.RUNNER_TOOL_CACHE ?? "/tmp/runner-tool-cache"
323
323
  * @public
324
324
  */
325
325
  var ToolInstaller = class ToolInstaller extends Context.Service()("@effected/github-actions/ToolInstaller") {
326
+ /**
327
+ * The live installer, over the runner's tool cache, `HttpClient` and `tar`.
328
+ *
329
+ * @remarks
330
+ * The cache root comes from `RUNNER_TOOL_CACHE`, resolved once at layer
331
+ * construction.
332
+ */
326
333
  static layer = Layer.effect(this, make);
327
334
  /**
328
335
  * Where a tool lives in the cache.
@@ -346,9 +353,8 @@ var ToolInstaller = class ToolInstaller extends Context.Service()("@effected/git
346
353
  * otherwise have to stub it in every test. The default is the static layout
347
354
  * over `RUNNER_TOOL_CACHE`, or the same off-runner root `make` resolves
348
355
  * (`internal/runner.ts`). **That is a read of the ambient environment**,
349
- * sanctioned here only because a double has no `ActionEnvironment` to ask —
350
- * test-double-only, and listed as such in the package's ambient-read
351
- * allowlist (`__test__/ambientReads.test.ts`).
356
+ * sanctioned here only because a double has no `ActionEnvironment` to ask,
357
+ * and limited to the test double.
352
358
  */
353
359
  static makeTest = (overrides = {}) => ({
354
360
  find: () => dies("find"),