-
Notifications
You must be signed in to change notification settings - Fork 853
docs(devlog): record the v2.28.0 release and its CI evidence #2192
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| # 120 — v2.28.0 release | ||
|
|
||
| Unit: 260820_bug_pr_backlog_consolidation | ||
|
|
||
| Published: `@bitkyc08/opencodex@2.28.0` as npm `latest`. | ||
|
|
||
| | Artifact | Value | | ||
| |---|---| | ||
| | Release commit | `584059132` (main) | | ||
| | Tag | `v2.28.0` → `5840591322117f3ee9568b35b135a6d4339f7711` | | ||
| | GitHub release | `v2.28.0`, 2026-08-20T09:17:50Z | | ||
| | Release workflow | run `32355161140`, **success**, head `584059132` | | ||
| | npm dist-tags | `latest: 2.28.0` | | ||
| | preview line | `2.28.0-preview.20260820` at `d2c700c1a` | | ||
|
|
||
| ## The CI stability claim, as measured rather than asserted | ||
|
|
||
| The release gate in `release.yml` is deliberately narrow: it requires a **successful push-event | ||
| `ci.yml` run for the exact release SHA on the release branch**. A PR run for the same SHA does | ||
| not qualify, because it ran against a merge ref under a different trigger context. | ||
|
|
||
| That gate was met: `main` push-event CI is **success at `584059132`** — the exact commit the | ||
| tag points at. | ||
|
|
||
| **`dev` CI is red at `96f288d59`, and that was checked rather than waved past.** The failures | ||
| are Windows-only: | ||
|
|
||
| - `windows 1/4`: WP13 composed `E` (54,074 ms) and `Restore truth` (45,197 ms). | ||
| - `windows 2/4`: journal-ownership start/ensure, and CL-10 deterministic bundle failing inside | ||
| `publishPrivateFileExclusive` on a `D:\` path. | ||
|
|
||
| Every non-Windows job in that same run succeeded. The Windows leg is `workflow_dispatch`-only | ||
| by design and is explicitly excluded from the release gate — `ci.yml:544-546` states that | ||
| `release.yml` gates on Linux + macOS + gates, and that "Windows re-enters the gate when the | ||
| tracked failures are fixed, not before" (issue #1059). These are the pre-existing failures | ||
| #2152 catalogues, not a regression from this range. | ||
|
|
||
| So: **not a green Windows leg, and not claimed as one.** The release shipped on the gate the | ||
| repository actually defines, with the red leg named and attributed. | ||
|
|
||
| ## Two things the release helper caught that a manual publish would not have | ||
|
|
||
| **The local gate failed on missing GUI dependencies, not on a defect.** The first run failed 7 | ||
| tests with `Cannot find package 'react'`. CI installs twice — root and then `gui/` — and builds | ||
| the GUI, because tests that fetch the served dashboard read their session bootstrap out of | ||
| `gui/dist/index.html`. The `ci.yml` comment at line 280 predicts this exact failure. After | ||
| `cd gui && bun install` plus `bun run build`, the gate passed and the publish proceeded. | ||
|
|
||
| **The helper is re-entrant and it proved it.** A later re-run refused with "release version | ||
| 2.28.0 is already partially or fully used", listing npm, the remote tag, and the GitHub release. | ||
| That is the metadata preflight working as intended: it is what turned an ambiguous "did that | ||
| publish land?" into a verified yes, and it is why the second attempt could not double-publish. | ||
|
|
||
| ## Verification performed | ||
|
|
||
| ``` | ||
| npm view @bitkyc08/opencodex version -> 2.28.0 | ||
| npm view ... dist-tags -> latest: 2.28.0 | ||
| git tag -l v2.28.0 -> v2.28.0 | ||
| gh release view v2.28.0 -> present | ||
| git merge-base --is-ancestor 584059132 origin/main -> YES | ||
| gh run view 32355161140 -> success @ 584059132 | ||
| ``` | ||
|
|
||
| A pushed commit and a dispatched workflow were not treated as a completed release; each artifact | ||
| above was read back from its own authority. | ||
|
|
||
| ## The preview channel, published after this record was first written | ||
|
|
||
| At the time the section above was written, `preview` carried the version commit but npm still | ||
| read `2.26.0-preview.20260819` — the channel had been trailing `latest` by a full release. It | ||
| has since been published on the same path. | ||
|
|
||
| | Artifact | Value | | ||
| |---|---| | ||
| | Release commit | `d2c700c1a` (preview) | | ||
| | Tag | `v2.28.0-preview.20260820` | | ||
| | GitHub release | `v2.28.0-preview.20260820`, pre-release, 2026-08-20T10:54:38Z | | ||
| | Release workflow | run `32361122670`, **success** | | ||
| | npm dist-tags | `preview: 2.28.0-preview.20260820` | | ||
|
|
||
| Both channels now sit on the same content, which is what `preview` is for and what it had | ||
| stopped being while it lagged a release behind. | ||
|
|
||
| The helper enforces the channel pairing itself rather than trusting the invocation: a | ||
| `preview` branch release must carry a `-preview.` version and publish to the `preview` | ||
| dist-tag, and `main` must be stable semver on `latest`. There is no argument combination that | ||
| crosses them. | ||
|
|
||
| **The last dispatch of this publish failed, and that failure is the guard working.** Run | ||
| `32361621459` refused with "v2.28.0-preview.20260820 already exists. Refusing to publish a | ||
| version with pre-existing Git metadata." A local shell had died mid-suite and the release was | ||
| restarted; by then run `32361122670` had already published. The refusal is what turned a | ||
| possible double-publish into a no-op, and it is the same preflight that caught the stable | ||
| re-run described above. | ||
|
|
||
| ## Two Linux failures that were not defects | ||
|
|
||
| `test 1/4` failed twice on `Codex autostart shim > an aged lock held by a live restore owner | ||
| is never reclaimed`, once on the stable release PR and once on the preview one. Both times it | ||
| hit the 60 s lane ceiling; both times it passed on re-run, and it passes locally in a 20 s | ||
| single-file run. The case spawns two real Bun processes and has one wait for the other's lock, | ||
| so it is spawn-latency-bound on a contended runner rather than assertion-bound. It carries no | ||
| budget of its own, unlike the cases in `tests/helpers/test-budget.ts`. | ||
|
|
||
| Worth naming rather than burying: two occurrences on the same case is a pattern, not noise. It | ||
| is not a release blocker — nothing about the shipped code changed between the red and green | ||
| runs — but it belongs on the same list as the Windows spawn-cost failures in #2152, and giving | ||
| it an intrinsic budget is the obvious next step. | ||
|
Comment on lines
+97
to
+109
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win 🧩 Analysis chain🏁 Script executed: #!/bin/bash
set -eu
printf '%s\n' '--- review file ---'
sed -n '80,115p' devlog/_plan/260820_bug_pr_backlog_consolidation/120_release_2280.md
printf '%s\n' '--- matching test and budget references ---'
rg -n -S 'aged lock held by a live restore owner|Codex autostart shim|test-budget|60 s|20 s' . \
-g '!node_modules' -g '!dist' -g '!build' | head -200
printf '%s\n' '--- candidate test files ---'
fd -t f -i 'test|spec|budget' . | head -200Repository: lidge-jun/opencodex Length of output: 50376 🏁 Script executed: #!/bin/bash
set -eu
printf '%s\n' '--- target test ---'
sed -n '1600,1695p' tests/codex-shim.test.ts
printf '%s\n' '--- budget definitions ---'
sed -n '1,180p' tests/helpers/test-budget.ts
printf '%s\n' '--- CI timeout helper ---'
sed -n '1,100p' tests/helpers/ci-watchdog.ts
printf '%s\n' '--- package test configuration ---'
rg -n -S 'timeout|ci-watchdog|codex-shim.test' package.json bunfig.toml .github scripts tests \
-g '!src/codex/data/upstream-models.json' | head -160Repository: lidge-jun/opencodex Length of output: 24169 🏁 Script executed: #!/bin/bash
set -eu
printf '%s\n' '--- remainder of target test ---'
sed -n '1690,1795p' tests/codex-shim.test.ts
printf '%s\n' '--- test-file timeout and process controls ---'
rg -n -C 4 -S 'setDefaultTimeout|Bun.spawn|spawn|kill|wait|releasePath|readyPath|restoreLockPath|timeout' tests/codex-shim.test.ts | tail -220
printf '%s\n' '--- suite runner timeout rationale ---'
sed -n '45,85p' scripts/test.ts
sed -n '495,520p' .github/workflows/ci.ymlRepository: lidge-jun/opencodex Length of output: 19146 🏁 Script executed: #!/bin/bash
set -eu
printf '%s\n' '--- auto-restore implementation ---'
rg -n -C 8 -S 'function autoRestoreCodexShim|autoRestoreCodexShim|afterRestoreLockAcquired|isRestoreLock|autorestore.lock|restore lock' src/codex/shim.ts | head -260
printf '%s\n' '--- lock helper implementations ---'
rg -n -C 12 -S 'acquire.*Lock|lock.*acquire|pidIs|process.*alive|kill\(.*0|defer|stale|createdAt' src/codex/shim.ts | head -320Repository: lidge-jun/opencodex Length of output: 16503 🏁 Script executed: #!/bin/bash
set -eu
printf '%s\n' '--- lock and auto-restore control flow ---'
sed -n '1350,1475p' src/codex/shim.ts
sed -n '2015,2095p' src/codex/shim.ts
printf '%s\n' '--- live-owner predicate ---'
rg -n -C 10 -S 'function isProcessAlive|isProcessAlive\(' src/codex/shim.ts
printf '%s\n' '--- read-only structural verifier ---'
python3 - <<'PY'
from pathlib import Path
import re
test = Path("tests/codex-shim.test.ts").read_text()
shim = Path("src/codex/shim.ts").read_text()
start = test.index('test("an aged lock held by a live restore owner is never reclaimed"')
end = test.index('test("stale-lock compare-and-delete never unlinks a successor lock"', start)
case = test[start:end]
assert "first = Bun.spawn" in case
assert "const second = spawnSync" in case
assert "writeFileSync(releasePath, \"release\", \"utf8\")" in case
assert case.index("const second = spawnSync") < case.index("writeFileSync(releasePath, \"release\", \"utf8\")")
acquire = shim[shim.index("function tryAcquireShimRestoreLock"):shim.index("function planGuardedRefreshTransaction")]
assert "for (let attempt = 0; attempt < 2; attempt += 1)" in acquire
assert "return null;" in acquire
assert "Bun.sleep" not in acquire
assert "setTimeout" not in acquire
restore = shim[shim.index("export function autoRestoreCodexShim"):shim.index("export function autoRestoreCodexShim") + 5000]
assert "const lock = tryAcquireShimRestoreLock" in restore
assert "if (!lock) return { status: \"deferred\" };" in restore
print("PASS: the test waits for the second child before releasing the first child's lock")
print("PASS: lock acquisition has no sleep or blocking wait and returns null after bounded attempts")
print("PASS: auto-restore maps a failed lock acquisition to deferred")
PYRepository: lidge-jun/opencodex Length of output: 10360 Separate the observed timeout from its cause.
🤖 Prompt for AI Agents |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Resolve the Markdown lint violations.
Line 36 starts with
#2152, which Markdown parses as an invalid ATX heading. WriteIssue#2152`` or wrap the issue number in code.Line 56 starts a fenced block without a language. Use
consolebecause the block contains commands and command output.Proposed fix
Static analysis reports MD018 on Line 36 and MD040 on Line 56.
Also applies to: 56-56
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 36-36: No space after hash on atx style heading
(MD018, no-missing-space-atx)
🤖 Prompt for AI Agents
Source: Linters/SAST tools