|
| 1 | +# 2026-06-23 v2.1.8 Release Plan |
| 2 | + |
| 3 | +## Objective |
| 4 | + |
| 5 | +Release the PR #16/#22 integration from `dev` to `main` as `@bitkyc08/opencodex@2.1.8`. |
| 6 | + |
| 7 | +The release must: |
| 8 | + |
| 9 | +- Re-verify `dev` after the PR #16/#22 integration. |
| 10 | +- Fast-forward or merge `dev` into `main`. |
| 11 | +- Use the repository release helper, not ad-hoc publish commands. |
| 12 | +- Publish `@bitkyc08/opencodex@2.1.8` with npm trusted publishing via GitHub Actions. |
| 13 | +- Verify npm, Git tag, GitHub Release, CI, and branch synchronization. |
| 14 | +- Resync `dev` to the release commit after the release helper creates `release: v2.1.8`. |
| 15 | + |
| 16 | +## Current State |
| 17 | + |
| 18 | +- Repository: `/Users/jun/Developer/new/700_projects/opencodex` |
| 19 | +- Current branch at planning time: `dev` |
| 20 | +- `dev` / `origin/dev`: `3a8852cb77037d2f70e5f0c2e3ebe3721140495f` |
| 21 | +- `main` / `origin/main`: `241e3277a7c0d7e76729a7ac6794a0851d52f9ea` |
| 22 | +- `package.json` version: `2.1.7` |
| 23 | +- Next release version: `2.1.8` |
| 24 | +- Preflight metadata: |
| 25 | + - `npm view @bitkyc08/opencodex@2.1.8 version`: not found. |
| 26 | + - `git ls-remote origin refs/tags/v2.1.8`: no tag output. |
| 27 | + - `gh release view v2.1.8`: release not found. |
| 28 | +- Open PR list: empty after PR #16 and #22 closeout. |
| 29 | + |
| 30 | +## Planned PABCD Work |
| 31 | + |
| 32 | +### P: Plan |
| 33 | + |
| 34 | +Create this devlog plan and record the release target/version. |
| 35 | + |
| 36 | +### A: Audit |
| 37 | + |
| 38 | +Dispatch a read-only plan auditor to verify: |
| 39 | + |
| 40 | +- `2.1.8` is the correct next patch after `2.1.7`. |
| 41 | +- `scripts/release.ts` is still the correct release path. |
| 42 | +- Release preflight should include local full tests, docs build, GUI build, CI, and metadata availability. |
| 43 | +- No release-blocking open PRs remain. |
| 44 | + |
| 45 | +### B: Build / Release Execution |
| 46 | + |
| 47 | +1. Re-verify on `dev`: |
| 48 | + - `bun run typecheck` |
| 49 | + - `bun test tests` |
| 50 | + - `bun run build:gui` |
| 51 | + - `cd docs-site && bun install --frozen-lockfile && bun run build` |
| 52 | + - `git diff --check` |
| 53 | +2. Merge `dev` to `main`: |
| 54 | + - Ensure clean tree. |
| 55 | + - Checkout `main`. |
| 56 | + - Fast-forward `main` to `dev` if possible. |
| 57 | + - Push `origin/main`. |
| 58 | +3. Wait for `main` Cross-platform CI on commit `3a8852c`. |
| 59 | +4. Release: |
| 60 | + - Run `bun scripts/release.ts 2.1.8 --publish` from clean `main`. |
| 61 | + - Let the helper bump `package.json`, commit `release: v2.1.8`, push `main`, wait for CI, dispatch release workflow, and watch the workflow. |
| 62 | +5. Verify release metadata: |
| 63 | + - `npm view @bitkyc08/opencodex@2.1.8 version` |
| 64 | + - `git ls-remote origin refs/tags/v2.1.8` |
| 65 | + - `gh release view v2.1.8 --json tagName,targetCommitish,url` |
| 66 | +6. Resync `dev`: |
| 67 | + - Fast-forward `dev` to the `release: v2.1.8` commit from `main`. |
| 68 | + - Push `origin/dev`. |
| 69 | + |
| 70 | +### C: Check |
| 71 | + |
| 72 | +Final checks: |
| 73 | + |
| 74 | +- `git status --short --branch` |
| 75 | +- `git rev-parse main origin/main dev origin/dev` |
| 76 | +- `gh run list` for release commit CI success. |
| 77 | +- `gh run list --workflow release.yml` for publish workflow success. |
| 78 | +- `npm view @bitkyc08/opencodex version` returns `2.1.8`. |
| 79 | +- `gh release view v2.1.8` exists. |
| 80 | + |
| 81 | +### D: Done |
| 82 | + |
| 83 | +Record the final result in `devlog/_plan/260623_v218_release/10_result.md`, save memory, and pause the goal only after an independent final objective review returns DONE. |
| 84 | + |
| 85 | +## Expected File Changes |
| 86 | + |
| 87 | +### NEW |
| 88 | + |
| 89 | +- `/Users/jun/Developer/new/700_projects/opencodex/devlog/_plan/260623_v218_release/00_plan.md` |
| 90 | +- `/Users/jun/Developer/new/700_projects/opencodex/devlog/_plan/260623_v218_release/10_result.md` |
| 91 | + |
| 92 | +### MODIFY |
| 93 | + |
| 94 | +- `/Users/jun/Developer/new/700_projects/opencodex/package.json` |
| 95 | + - version `2.1.7` -> `2.1.8` |
| 96 | + - This change should be created by `scripts/release.ts`. |
| 97 | + |
| 98 | +## Risks |
| 99 | + |
| 100 | +- Release workflow could fail after npm publish. Mitigation: `scripts/release.ts` checks npm, tag, and GitHub Release are unused before publishing. |
| 101 | +- `origin/main` could move while waiting for CI. Mitigation: release helper aborts if remote main no longer equals the release commit. |
| 102 | +- Docs build is not part of CI. Mitigation: run `docs-site` build locally before main merge/release. |
| 103 | +- GUI build is not in full local test by default. Mitigation: run `bun run build:gui` before release and rely on CI GUI build smoke after push. |
| 104 | +- npm trusted publishing may fail due GitHub/npm configuration. Mitigation: do not use token fallback unless the trusted publishing failure proves it is necessary; report exact failure. |
| 105 | + |
| 106 | +## Completion Criteria |
| 107 | + |
| 108 | +- `origin/main` includes PR #16/#22 integration and `release: v2.1.8`. |
| 109 | +- `origin/dev` is synchronized to the same release commit. |
| 110 | +- npm latest resolves to `@bitkyc08/opencodex@2.1.8`. |
| 111 | +- Git tag `v2.1.8` exists. |
| 112 | +- GitHub Release `v2.1.8` exists. |
| 113 | +- Cross-platform CI succeeded for the release commit. |
| 114 | +- Release workflow succeeded. |
| 115 | +- PABCD reaches D and independent final reviewer returns DONE. |
0 commit comments