@effected/github-actions 0.7.0 → 0.8.0

package/ActionEnvironment.js

@@ -286,6 +286,26 @@ var ActionEnvironment = class ActionEnvironment extends Context.Service()("@effe
 	* `undefined` means *not served*, so a suite cannot arrange `undefined` as
 	* the payload itself. A webhook payload is always a JSON object; the case
 	* does not arise, and reserving the sentinel keeps the argument optional.
+	*
+	* When a suite wants the **real read path** rather than a served value —
+	* exercising the actual `GITHUB_EVENT_PATH` read-and-parse — this member is
+	* the seam: it leaves `FileSystem` in `R` precisely so the suite chooses
+	* the filesystem. Compose it with `@effected/memfs`'s seeded in-memory
+	* volume rather than a hand-rolled stub: the volume honors the whole
+	* `FileSystem` contract, and an unseeded path fails typed `NotFound`
+	* instead of whatever a hand stub happens to answer.
+	*
+	* @example
+	* ```ts
+	* import { ActionEnvironment } from "@effected/github-actions";
+	* import { MemoryFileSystem } from "@effected/memfs";
+	* import { Layer } from "effect";
+	*
+	* const layer = Layer.effect(
+	*   ActionEnvironment,
+	*   ActionEnvironment.makeTest({ GITHUB_EVENT_PATH: "/event.json" }),
+	* ).pipe(Layer.provide(MemoryFileSystem.layerWith({ "/event.json": JSON.stringify({ action: "opened" }) })));
+	* ```
 	*/
 	static makeTest = (overrides = {}, payload) => Effect.map(make({
 		...TEST_DEFAULTS,
@@ -302,7 +322,10 @@ var ActionEnvironment = class ActionEnvironment extends Context.Service()("@effe
 	* The stub is why the payload has to be served here rather than through the
 	* filesystem: `make` captures the filesystem at construction, so seeding
 	* `GITHUB_EVENT_PATH` through `overrides` would send the read to a noop
-	* filesystem and fail. Pass the payload as the second argument instead.
+	* filesystem and fail. Pass the payload as the second argument instead —
+	* or, for a suite that wants the real read path over a full filesystem,
+	* compose {@link ActionEnvironment.makeTest} with `@effected/memfs`'s
+	* seeded volume; the recipe is on that member.
 	*
 	* @example
 	* ```ts

package/README.md

@@ -8,7 +8,7 @@
 The GitHub Actions runtime for [Effect](https://effect.website) v4: the services an action needs to talk to the runner it is executing inside. `Action.run` composes the runtime, runs your program, renders a failure as an `::error::` annotation and sets the exit code. `ActionInput` reads workflow inputs as typed `Config` values — string, boolean, integer, redacted secret, multiline list, `key=value` pairs, or a schema-decoded JSON blob — with one absence rule shared by every accessor: unset and `""` are both missing data. `ActionOutputs`, `ActionState`, `ActionLogger` and a fiber-local `ActionEnvironment` round out the runner surface, alongside `ActionCache`, `Artifact`, a metadata-carrying `BlobStore` (S3-compatible or the runner's own cache), `OidcTokenIssuer` and `ToolInstaller` for the heavier protocols. A reporting suite — `GitHubMarkdown`, `ManagedDocument`, `CheckState` and `CheckDocument` — covers the other direction: rendering what a run did onto a pull request comment, a check run or the job summary. No `@actions/*` dependency anywhere — the cache, artifact and tool-cache protocols are implemented directly against their HTTP APIs.
 
 > **Pre-release.** This package is part of the `@effected/*` kit, in pre-`1.0.0`
-> development against a single pinned Effect v4 beta. Packages graduate to
+> development against a single pinned Effect v4 prerelease. Packages graduate to
 > `1.0.0` once Effect `4.0.0` ships. To hold your own `effect` versions at
 > exactly the ones the kit is built and tested against, install
 > [`@effected/pnpm-plugin-effect`](https://www.npmjs.com/package/@effected/pnpm-plugin-effect).

package/index.d.ts

@@ -194,6 +194,26 @@ declare class ActionEnvironment extends ActionEnvironment_base {
    * `undefined` means *not served*, so a suite cannot arrange `undefined` as
    * the payload itself. A webhook payload is always a JSON object; the case
    * does not arise, and reserving the sentinel keeps the argument optional.
+   *
+   * When a suite wants the **real read path** rather than a served value —
+   * exercising the actual `GITHUB_EVENT_PATH` read-and-parse — this member is
+   * the seam: it leaves `FileSystem` in `R` precisely so the suite chooses
+   * the filesystem. Compose it with `@effected/memfs`'s seeded in-memory
+   * volume rather than a hand-rolled stub: the volume honors the whole
+   * `FileSystem` contract, and an unseeded path fails typed `NotFound`
+   * instead of whatever a hand stub happens to answer.
+   *
+   * @example
+   * ```ts
+   * import { ActionEnvironment } from "@effected/github-actions";
+   * import { MemoryFileSystem } from "@effected/memfs";
+   * import { Layer } from "effect";
+   *
+   * const layer = Layer.effect(
+   *   ActionEnvironment,
+   *   ActionEnvironment.makeTest({ GITHUB_EVENT_PATH: "/event.json" }),
+   * ).pipe(Layer.provide(MemoryFileSystem.layerWith({ "/event.json": JSON.stringify({ action: "opened" }) })));
+   * ```
    */
   static readonly makeTest: (overrides?: Readonly<Record<string, string>>, payload?: unknown) => Effect.Effect<ActionEnvironmentShape, never, FileSystem.FileSystem>;
   /**
@@ -204,7 +224,10 @@ declare class ActionEnvironment extends ActionEnvironment_base {
    * The stub is why the payload has to be served here rather than through the
    * filesystem: `make` captures the filesystem at construction, so seeding
    * `GITHUB_EVENT_PATH` through `overrides` would send the read to a noop
-   * filesystem and fail. Pass the payload as the second argument instead.
+   * filesystem and fail. Pass the payload as the second argument instead —
+   * or, for a suite that wants the real read path over a full filesystem,
+   * compose {@link ActionEnvironment.makeTest} with `@effected/memfs`'s
+   * seeded volume; the recipe is on that member.
    *
    * @example
    * ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/github-actions",
-	"version": "0.7.0",
+	"version": "0.8.0",
 	"private": false,
 	"description": "The GitHub Actions runtime: env, inputs, outputs, state, logging, cache, artifacts, blob storage, OIDC and the token bridge.",
 	"keywords": [
@@ -39,16 +39,16 @@
 	},
 	"dependencies": {
 		"@azure/storage-blob": "^12.33.0",
-		"@effected/github": "^0.4.2",
-		"@effected/glob": "^0.3.0",
-		"@effected/markdown": "^0.5.1",
-		"@effected/npm": "^0.9.0",
-		"@effected/sbom": "^0.3.1",
-		"@effected/templates": "^0.2.0"
+		"@effected/github": "^0.5.0",
+		"@effected/glob": "^0.4.0",
+		"@effected/markdown": "^0.6.0",
+		"@effected/npm": "^0.10.0",
+		"@effected/sbom": "^0.4.0",
+		"@effected/templates": "^0.3.0"
 	},
 	"peerDependencies": {
-		"@effect/platform-node": "4.0.0-beta.107",
-		"effect": "4.0.0-beta.107"
+		"@effect/platform-node": "4.0.0-rc.109",
+		"effect": "4.0.0-rc.109"
 	},
 	"engines": {
 		"node": ">=24.11.0"