chore: version packages - #1
Merged
Merged
Conversation
5 tasks
rajkaria
added a commit
that referenced
this pull request
May 23, 2026
* SP13: docs cleanup + migration guide + version-sync CI gate Clubs P0 #1 + #14 + closes #5's CI-benchmark hook from the post-v1 roadmap. Single PR; net additive — no public API changes. Docs: - New /migrate-from-official-sdks guide with before/after code blocks for storage / compute / DA. Three side-by-side primitives, real install diffs, what-you-gain rollup, hybrid-usage escape hatch documented. - Sidebar nav: new "Migration" section under Guides. - 13 stale `rajkaria/0g-ai-kit` slug refs in MDX rewritten to `rajkaria/0gkit` (D13 repo rename was never propagated to the per-package docs). - 8 template README Vercel deploy buttons + inline links flipped from `0gkit.dev` to `docs.0gkit.com` (D38). - `getting-started/page.mdx` no longer pins `0.1.0` for the @foundryprotocol scope — uses `@latest` per the SP13 canonical pattern. - Storage / compute `next major` deprecation notes corrected to `v2` (we shipped v1.0; "removed in v1.0" was self-contradictory). CI gates: - `docs:check --versions` — fails if any MDX/README pins a `@foundryprotocol/0gkit-*@x.y.z` lower than the live package.json. Wired into existing `pnpm docs:check`; runs in main CI alongside codes + exports. 17 new node:test cases (semver compare, pin discovery, version diff, edge cases). - `.github/workflows/perf-benchmark.yml` — `0g --help` cold-start, p50/p95/max via `scripts/bench-cli-coldstart.mjs` with 5000ms p95 budget on Node 22. Baseline JSON uploaded as artifact per run. Local run: p50=965ms / p95=2718ms (well under budget). Source: - `0gkit-storage` + `0gkit-compute`: deprecation warnings on `{ privateKey }` / `{ brokerKey }` no longer promise removal "in v0.3" (we are past v1.0); now say "removed in v2" to match the v1.0 stability commitment. Templates: - `storage-app` README drops the stale `@0.3.0` pin on `0gkit-storage`. - `inference-app` bumps the upstream `@0gfoundation/0g-compute-ts-sdk` peer from `^0.3.0` to `^0.8.3` (current upstream). Verification: - `pnpm docs:check` — 14 codes / 16 packages / 0 stale version pins — all green. - `pnpm boundary:check` — 302 modules / 0 violations. - `pnpm test:scripts` — 37 tests / 37 pass (29 docs-check + 8 bench). - `pnpm typecheck` — 34/34 tasks green via turbo. - `pnpm templates:check` — 9 templates OK. - `pnpm format:check` — clean. - Cold-start bench locally on Apple Silicon: p95 2718ms (budget 5000ms). * ci(perf-benchmark): build the whole workspace before bench runs The CLI imports several 0gkit-* packages at runtime — building only 0gkit-cli leaves chain/storage/compute/da dist/ missing and the bench exits with ERR_MODULE_NOT_FOUND on the first invocation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Coordinated patch bump for the
@foundryprotocol/0gkit-*linked group, driven by thefix-ethers-peer-pinchangeset. Created manually because the repo's "Allow GitHub Actions to create and approve pull requests" setting is currently off, so the Release workflow could pushchangeset-release/mainbut not open this PR itself.What ships at 0.1.1
@foundryprotocol/0gkit-storage— peerethers^6.16.0→6.13.1(matches@0gfoundation/0g-storage-ts-sdk@1.2.9's exact pin sonpm installno longer ERESOLVEs).@foundryprotocol/0gkit-compute— peerethers^6.16.0→^6.13.1(matches@0gfoundation/0g-compute-ts-sdk@0.8.3).@foundryprotocol/0gkit-cli/-mcp/-react— passive linked bumps (they consume storage+compute via workspace; pnpm publish will rewrite the dep ranges to^0.1.1).npm install ... ethers@6.13.1.Test plan
pnpm format:check / lint / build / test / typecheck / boundary:checkgreen onmainafter the underlying fix landed@foundryprotocol/0gkit-*@0.1.1to npmFollow-up
Enable Settings → Actions → General → "Allow GitHub Actions to create and approve pull requests" so future changeset Version PRs open automatically.
🤖 Generated with Claude Code