@effected/github 0.4.0 → 0.4.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.
Files changed (2) hide show
  1. package/index.d.ts +21 -0
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -1165,6 +1165,15 @@ interface CodeScanningShape {
1165
1165
  * The endpoint answers **202 Accepted** and configures asynchronously.
1166
1166
  * Nothing here polls: a successful call means GitHub accepted the request,
1167
1167
  * not that scanning is running.
1168
+ *
1169
+ * **Turning it back off does not undo everything it did.** Setting `state`
1170
+ * to `not-configured` stops default setup, but the synthetic CodeQL workflow
1171
+ * GitHub created when it was enabled **survives** — it remains listed among
1172
+ * the repository's workflows afterwards. A caller that treats "default setup
1173
+ * is off" as "no CodeQL workflow exists" will be wrong, and one that counts
1174
+ * workflows to decide whether a repository has any CI will count that one.
1175
+ * Reported by `@spencerbeggs/reposets` (dogfood round 8, 2026-08-14) from a
1176
+ * real organization, not inferred from the API description.
1168
1177
  */
1169
1178
  readonly configure: (setup: CodeScanningSetup) => Effect.Effect<void, GitHubError, Repo>;
1170
1179
  /**
@@ -2827,6 +2836,18 @@ interface RepositoryVariableShape {
2827
2836
  * `notFound` is absorbed — a 403 from a mis-scoped token still fails, where
2828
2837
  * treating any error as absence would turn a permissions problem into a
2829
2838
  * spurious create.
2839
+ *
2840
+ * **The 404-for-absent behaviour is documented, not probed.** Neither this
2841
+ * suite nor the first consumer's has issued this read against real GitHub —
2842
+ * both run against doubles.
2843
+ *
2844
+ * Only `notFound` selects the create branch: a successful read selects the
2845
+ * update branch, and any other failure propagates rather than being guessed
2846
+ * at. So if GitHub answers something *other* than 404 for an absent
2847
+ * variable, the write does not silently take the wrong branch — it either
2848
+ * `PATCH`es a variable that is not there, or fails with the error GitHub
2849
+ * actually sent. Read either as evidence about this assumption rather than
2850
+ * about the caller.
2830
2851
  */
2831
2852
  readonly set: (name: string, value: string) => Effect.Effect<void, GitHubError, Repo>;
2832
2853
  /** The repository's variables, with their values. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@effected/github",
3
- "version": "0.4.0",
3
+ "version": "0.4.1",
4
4
  "private": false,
5
5
  "description": "Typed GitHub REST and GraphQL services over the octokit core request surface, with app auth and resource helpers.",
6
6
  "keywords": [