@effected/github 0.23.1 → 0.25.0

package/README.md

@@ -184,9 +184,13 @@ const program = Effect.gen(function* () {
     security_and_analysis: { secret_scanning: "enabled" },
   });
 });
-// AppliedSettings — { rest: [...], graphql: [...] }, in the caller's own key names.
-// The two lists agree with the input right up until preparation drops a field
+// AppliedSettings — { rest: [...], graphql: [...], ignored: [...] }, in the caller's own key names.
+// The lists agree with the input right up until preparation drops a field
 // GitHub would reject, which is what a person reading a dry run is checking for.
+// `ignored` names keys neither API accepts (a typo, say): they are never sent,
+// because the REST PATCH would ignore them and still answer 200. The REST key
+// list is generated from GitHub's OpenAPI description; a key a later
+// api-version removed is ignored only for a client pinned at or past it.
 ```
 
 `updateSettings` takes octokit's own generated params, and those spell an optional field as `has_issues?: boolean` rather than `has_issues?: boolean | undefined` — so under `exactOptionalPropertyTypes` a `Partial<T>` built from your own settings schema does not assign to it at all. `repositoryPatch` is the supported way out, and it exists so the answer is never a cast:
@@ -295,14 +299,14 @@ const TestClient = GitHubClient.layerFixture(fixtures);
 
 - `GitHubClient` — the typed transport: `request`, `requestDecoded` (a mandatory-schema escape hatch for routes outside the generated map), `paginate` / `paginateStream`, `graphql`, and `rateLimit` (observation only — nothing here throttles on your behalf).
 - `Repo` / `RepoRef` — the `{ owner, repo }` coordinate, resolved per call through `R`, with `Repo.provide` for multi-repository programs.
-- `GitHubRepository` — the repository's settings as GitHub's own generated type, plus `defaultBranch`, `nodeId`, `ownerType` for gating organization-only fields, and `applySettings` reporting the keys it actually sent.
+- `GitHubRepository` — the repository's settings as GitHub's own generated type, plus `defaultBranch`, `nodeId`, `ownerType` for gating organization-only fields, `applySettings` reporting the keys it actually sent, and `topics` / `setTopics(names)`, where `setTopics` replaces the whole set and returns what GitHub stored (lowercased).
 - `repositoryPatch` / `RepositoryPatchDraft` — build an `updateSettings` patch from fields that may be `undefined`, under `exactOptionalPropertyTypes`, without a cast.
 - `GitHubError` / `GitHubGraphQLError` — one error per transport, `kind`-routed with `hasKind` for `Effect.catchIf`; a REST 422's validation entries ride on `validation`, matched with `hasValidationCode`.
 - `RetryPolicy` — the client's one retry policy: full-jitter backoff, server-advised delays honored up to a ceiling.
 - `GitHubApp` — App JWT signing, installation token minting/revocation, app and installation identity, and `clientLayer` for an App-authenticated `GitHubClient`.
 - `GitBranch` / `GitTag` — Git Database API refs, with `upsert` collapsing the create-or-reset dance to one call and `GitTag.latestSemver` picking the newest version-shaped tag in one pass.
 - `CheckRun` — `withCheckRun` concludes on every exit path; `CheckRunOutput.truncated()` cuts rendered output to GitHub's byte limits.
-- `PullRequest` / `PullRequestComment` — upserts for both, `listFiles` answering with the same full `CommitFile` records a commit read returns, `headSha`/`baseSha` on `PullRequestInfo`, plus `CommentMarker` for finding a sticky comment again.
+- `PullRequest` / `PullRequestComment` — upserts for both, `listFiles` answering with the same full `CommitFile` records a commit read returns, `headSha`/`baseSha` on `PullRequestInfo`, plus `CommentMarker` for finding a sticky comment again. `PullRequestInfo.mergeCommitSha` is read from GraphQL `mergeCommit.oid` for merged pull requests only, because the REST object no longer carries it: `get`, `update` and `upsert` always fill it, while `list` and `listAssociatedWithCommit` fill it only with `mergeCommits: true` (one GraphQL call per 100 merged pull requests).
 - `GitHubIssue` — issues and their comments, including `commentOnce` for a marked comment that is posted exactly once and never edited, and `linkedIssues` for what a pull request closes.
 - `harvestIssueReferences` / `parseBareLineReference` — a compatibility re-export of the two closing-reference dialects that moved to `@effected/github-references`, with `CLOSING_KEYWORDS` and their result types.
 - `GitHubRelease` — releases and asset uploads, including the one route (`uploadAsset`, with the endpoint's optional display label) outside GitHub's generated endpoint map.

package/RepositorySecret.js

@@ -1,4 +1,5 @@
 import { GitHubError } from "./GitHubError.js";
+import { unstubbed } from "./internal/unstubbed.js";
 import { GitHubClient } from "./GitHubClient.js";
 import { Repo } from "./Repo.js";
 import { encryptSecret } from "./internal/crypto.js";
@@ -70,21 +71,19 @@ var RepositorySecret = class RepositorySecret extends Context.Service()("@effect
 	* further down throws at import time with a clean typecheck.
 	*/
 	static layer = Layer.effect(this, Effect.map(GitHubClient, (client) => make(client)));
-	/** An in-memory double; unstubbed members die naming themselves. */
+	/** An in-memory double; an unstubbed member dies when run, naming itself. */
 	static makeTest = (overrides = {}) => ({
-		set: overrides.set ?? (() => unstubbed("set")),
-		list: overrides.list ?? (() => unstubbed("list")),
-		delete: overrides.delete ?? (() => unstubbed("delete")),
-		setForEnvironment: overrides.setForEnvironment ?? (() => unstubbed("setForEnvironment")),
-		listForEnvironment: overrides.listForEnvironment ?? (() => unstubbed("listForEnvironment")),
-		deleteForEnvironment: overrides.deleteForEnvironment ?? (() => unstubbed("deleteForEnvironment"))
+		set: overrides.set ?? (() => dies("set")),
+		list: overrides.list ?? (() => dies("list")),
+		delete: overrides.delete ?? (() => dies("delete")),
+		setForEnvironment: overrides.setForEnvironment ?? (() => dies("setForEnvironment")),
+		listForEnvironment: overrides.listForEnvironment ?? (() => dies("listForEnvironment")),
+		deleteForEnvironment: overrides.deleteForEnvironment ?? (() => dies("deleteForEnvironment"))
 	});
 	/** {@link RepositorySecret.makeTest} behind a `Layer`. */
 	static layerTest = (overrides = {}) => Layer.succeed(RepositorySecret, RepositorySecret.makeTest(overrides));
 };
-const unstubbed = (member) => {
-	throw new Error(`RepositorySecret.makeTest: ${member}() was called but not stubbed — pass an override.`);
-};
+const dies = unstubbed("RepositorySecret.makeTest");
 /**
 * Seal a value, turning a malformed public key into a typed failure.
 *

package/RepositorySecurity.js

@@ -1,3 +1,4 @@
+import { unstubbed } from "./internal/unstubbed.js";
 import { GitHubClient } from "./GitHubClient.js";
 import { Repo } from "./Repo.js";
 import { Context, Effect, Layer } from "effect";
@@ -56,21 +57,19 @@ var RepositorySecurity = class RepositorySecurity extends Context.Service()("@ef
 	* further down throws at import time with a clean typecheck.
 	*/
 	static layer = Layer.effect(this, Effect.map(GitHubClient, (client) => make(client)));
-	/** An in-memory double; unstubbed members die naming themselves. */
+	/** An in-memory double; an unstubbed member dies when run, naming itself. */
 	static makeTest = (overrides = {}) => ({
-		vulnerabilityAlerts: overrides.vulnerabilityAlerts ?? (() => unstubbed("vulnerabilityAlerts")),
-		setVulnerabilityAlerts: overrides.setVulnerabilityAlerts ?? (() => unstubbed("setVulnerabilityAlerts")),
-		automatedSecurityFixes: overrides.automatedSecurityFixes ?? (() => unstubbed("automatedSecurityFixes")),
-		setAutomatedSecurityFixes: overrides.setAutomatedSecurityFixes ?? (() => unstubbed("setAutomatedSecurityFixes")),
-		privateVulnerabilityReporting: overrides.privateVulnerabilityReporting ?? (() => unstubbed("privateVulnerabilityReporting")),
-		setPrivateVulnerabilityReporting: overrides.setPrivateVulnerabilityReporting ?? (() => unstubbed("setPrivateVulnerabilityReporting"))
+		vulnerabilityAlerts: overrides.vulnerabilityAlerts ?? (() => dies("vulnerabilityAlerts")),
+		setVulnerabilityAlerts: overrides.setVulnerabilityAlerts ?? (() => dies("setVulnerabilityAlerts")),
+		automatedSecurityFixes: overrides.automatedSecurityFixes ?? (() => dies("automatedSecurityFixes")),
+		setAutomatedSecurityFixes: overrides.setAutomatedSecurityFixes ?? (() => dies("setAutomatedSecurityFixes")),
+		privateVulnerabilityReporting: overrides.privateVulnerabilityReporting ?? (() => dies("privateVulnerabilityReporting")),
+		setPrivateVulnerabilityReporting: overrides.setPrivateVulnerabilityReporting ?? (() => dies("setPrivateVulnerabilityReporting"))
 	});
 	/** {@link RepositorySecurity.makeTest} behind a `Layer`. */
 	static layerTest = (overrides = {}) => Layer.succeed(RepositorySecurity, RepositorySecurity.makeTest(overrides));
 };
-const unstubbed = (member) => {
-	throw new Error(`RepositorySecurity.makeTest: ${member}() was called but not stubbed — pass an override.`);
-};
+const dies = unstubbed("RepositorySecurity.makeTest");
 const make = (client) => {
 	return {
 		vulnerabilityAlerts: Effect.fn("RepositorySecurity.vulnerabilityAlerts")(function* () {

package/RepositoryVariable.js

@@ -1,3 +1,4 @@
+import { unstubbed } from "./internal/unstubbed.js";
 import { GitHubClient } from "./GitHubClient.js";
 import { Repo } from "./Repo.js";
 import { Context, Effect, Layer } from "effect";
@@ -40,21 +41,19 @@ var RepositoryVariable = class RepositoryVariable extends Context.Service()("@ef
 	* further down throws at import time with a clean typecheck.
 	*/
 	static layer = Layer.effect(this, Effect.map(GitHubClient, (client) => make(client)));
-	/** An in-memory double; unstubbed members die naming themselves. */
+	/** An in-memory double; an unstubbed member dies when run, naming itself. */
 	static makeTest = (overrides = {}) => ({
-		set: overrides.set ?? (() => unstubbed("set")),
-		list: overrides.list ?? (() => unstubbed("list")),
-		delete: overrides.delete ?? (() => unstubbed("delete")),
-		setForEnvironment: overrides.setForEnvironment ?? (() => unstubbed("setForEnvironment")),
-		listForEnvironment: overrides.listForEnvironment ?? (() => unstubbed("listForEnvironment")),
-		deleteForEnvironment: overrides.deleteForEnvironment ?? (() => unstubbed("deleteForEnvironment"))
+		set: overrides.set ?? (() => dies("set")),
+		list: overrides.list ?? (() => dies("list")),
+		delete: overrides.delete ?? (() => dies("delete")),
+		setForEnvironment: overrides.setForEnvironment ?? (() => dies("setForEnvironment")),
+		listForEnvironment: overrides.listForEnvironment ?? (() => dies("listForEnvironment")),
+		deleteForEnvironment: overrides.deleteForEnvironment ?? (() => dies("deleteForEnvironment"))
 	});
 	/** {@link RepositoryVariable.makeTest} behind a `Layer`. */
 	static layerTest = (overrides = {}) => Layer.succeed(RepositoryVariable, RepositoryVariable.makeTest(overrides));
 };
-const unstubbed = (member) => {
-	throw new Error(`RepositoryVariable.makeTest: ${member}() was called but not stubbed — pass an override.`);
-};
+const dies = unstubbed("RepositoryVariable.makeTest");
 const make = (client) => {
 	/**
 	* Does this variable already exist? One by-name read, not a listing.

package/Ruleset.js

@@ -1,4 +1,5 @@
 import { GitHubError } from "./GitHubError.js";
+import { unstubbed } from "./internal/unstubbed.js";
 import { GitHubClient } from "./GitHubClient.js";
 import { Repo } from "./Repo.js";
 import { Context, Effect, Layer } from "effect";
@@ -52,20 +53,18 @@ var Ruleset = class Ruleset extends Context.Service()("@effected/github/Ruleset"
 	* further down throws at import time with a clean typecheck.
 	*/
 	static layer = Layer.effect(this, Effect.map(GitHubClient, (client) => make(client)));
-	/** An in-memory double; unstubbed members die naming themselves. */
+	/** An in-memory double; an unstubbed member dies when run, naming itself. */
 	static makeTest = (overrides = {}) => ({
-		upsert: overrides.upsert ?? (() => unstubbed("upsert")),
-		list: overrides.list ?? (() => unstubbed("list")),
-		delete: overrides.delete ?? (() => unstubbed("delete")),
-		teamId: overrides.teamId ?? (() => unstubbed("teamId")),
-		roleId: overrides.roleId ?? (() => unstubbed("roleId"))
+		upsert: overrides.upsert ?? (() => dies("upsert")),
+		list: overrides.list ?? (() => dies("list")),
+		delete: overrides.delete ?? (() => dies("delete")),
+		teamId: overrides.teamId ?? (() => dies("teamId")),
+		roleId: overrides.roleId ?? (() => dies("roleId"))
 	});
 	/** {@link Ruleset.makeTest} behind a `Layer`. */
 	static layerTest = (overrides = {}) => Layer.succeed(Ruleset, Ruleset.makeTest(overrides));
 };
-const unstubbed = (member) => {
-	throw new Error(`Ruleset.makeTest: ${member}() was called but not stubbed — pass an override.`);
-};
+const dies = unstubbed("Ruleset.makeTest");
 /** An inherited ruleset belongs to the organization and is not this repository's to write. */
 const isOwnedByRepository = (ruleset) => ruleset.source_type !== "Organization";
 const make = (client) => {

package/WorkflowDispatch.js

@@ -1,4 +1,5 @@
 import { GitHubError } from "./GitHubError.js";
+import { unstubbed, unstubbedRead } from "./internal/unstubbed.js";
 import { GitHubClient } from "./GitHubClient.js";
 import { Repo } from "./Repo.js";
 import { numericId } from "./internal/ids.js";
@@ -75,21 +76,20 @@ const DEFAULT_TIMEOUT = Duration.minutes(5);
 var WorkflowDispatch = class WorkflowDispatch extends Context.Service()("@effected/github/WorkflowDispatch") {
 	/** The live service, built over a `GitHubClient`. */
 	static layer = Layer.effect(this, Effect.map(GitHubClient, (client) => make(client)));
-	/** An in-memory double; unstubbed members die naming themselves. */
+	/** An in-memory double; an unstubbed member dies when run, naming itself. */
 	static makeTest = (overrides = {}) => ({
-		dispatch: overrides.dispatch ?? (() => unstubbed("dispatch")),
-		dispatchWithRun: overrides.dispatchWithRun ?? (() => unstubbed("dispatchWithRun")),
-		runStatus: overrides.runStatus ?? (() => unstubbed("runStatus")),
-		cancelRun: overrides.cancelRun ?? (() => unstubbed("cancelRun")),
-		list: overrides.list ?? Effect.sync(() => unstubbed("list")),
-		dispatchAndWait: overrides.dispatchAndWait ?? (() => unstubbed("dispatchAndWait"))
+		dispatch: overrides.dispatch ?? (() => dies("dispatch")),
+		dispatchWithRun: overrides.dispatchWithRun ?? (() => dies("dispatchWithRun")),
+		runStatus: overrides.runStatus ?? (() => dies("runStatus")),
+		cancelRun: overrides.cancelRun ?? (() => dies("cancelRun")),
+		list: overrides.list ?? unread("list"),
+		dispatchAndWait: overrides.dispatchAndWait ?? (() => dies("dispatchAndWait"))
 	});
 	/** {@link WorkflowDispatch.makeTest} behind a `Layer`. */
 	static layerTest = (overrides = {}) => Layer.succeed(WorkflowDispatch, WorkflowDispatch.makeTest(overrides));
 };
-const unstubbed = (member) => {
-	throw new Error(`WorkflowDispatch.makeTest: ${member}() was called but not stubbed — pass an override.`);
-};
+const dies = unstubbed("WorkflowDispatch.makeTest");
+const unread = unstubbedRead("WorkflowDispatch.makeTest");
 const statusOf = (raw) => WorkflowRunStatus.make({
 	id: numericId(raw.id),
 	status: raw.status ?? "unknown",
@@ -104,6 +104,8 @@ const DispatchResponse = Schema.Struct({
 });
 const decodeDispatchResponse = Schema.decodeUnknownEffect(DispatchResponse);
 const decodeDispatchedRun = Schema.decodeUnknownEffect(DispatchedRun);
+/** The api-version that reports the run unasked and removed `return_run_details`. */
+const RUN_DETAILS_BY_DEFAULT = "2026-03-10";
 const make = (client) => {
 	const dispatch = Effect.fn("WorkflowDispatch.dispatch")(function* (workflow, ref, inputs) {
 		const { owner, repo } = yield* Repo;
@@ -135,7 +137,7 @@ const make = (client) => {
 			workflow_id: workflow,
 			ref,
 			...inputs !== void 0 ? { inputs } : {},
-			return_run_details: true
+			...client.apiVersion < RUN_DETAILS_BY_DEFAULT ? { return_run_details: true } : {}
 		});
 		if (data === "" || data === null) return Option.none();
 		const run = yield* decodeDispatchResponse(data).pipe(Effect.flatMap((raw) => decodeDispatchedRun({