From ce00c74d588f3230742df7d9eb04810736f71e1a Mon Sep 17 00:00:00 2001 From: Sabry Dawood Date: Wed, 28 Oct 2026 11:51:26 +0000 Subject: [PATCH] docs: install and build the client with bun The client now uses bun as its only package manager (Deploy-Center-Client #2), so the FAQ, the v2 to v3 migration guide, the GitHub setup example and the staging checklist install with a frozen bun lockfile. Signed-off-by: Sabry Dawood --- docs/FAQ.md | 4 ++-- docs/guides/GITHUB_SETUP.md | 10 +++++----- docs/migration-v2-to-v3.md | 4 ++-- docs/v3.0-staging-verification.md | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 3e8557f..f7da755 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -217,10 +217,10 @@ git pull origin main # Update dependencies cd server && npm install -cd ../client && npm install +cd ../client && bun install --frozen-lockfile # Build -cd ../client && npm run build +cd ../client && bun run build cd ../server && npm run build # Restart diff --git a/docs/guides/GITHUB_SETUP.md b/docs/guides/GITHUB_SETUP.md index 3355ece..e18687e 100644 --- a/docs/guides/GITHUB_SETUP.md +++ b/docs/guides/GITHUB_SETUP.md @@ -590,12 +590,12 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: actions/setup-node@v4 + - uses: oven-sh/setup-bun@v2 with: - node-version: '20' - - run: cd client && npm ci - - run: cd client && npm test - - run: cd client && npm run lint + bun-version: '1.4.4' + - run: cd client && bun install --frozen-lockfile + - run: cd client && bun run test -- --run + - run: cd client && bun run lint ``` #### 2. Auto-label PRs diff --git a/docs/migration-v2-to-v3.md b/docs/migration-v2-to-v3.md index be738df..4951203 100644 --- a/docs/migration-v2-to-v3.md +++ b/docs/migration-v2-to-v3.md @@ -63,7 +63,7 @@ queueing auto-resumes. git fetch --tags git checkout v3.0.0 # the GA tag (or v3.0.0-rc.1 for staging) cd server && npm install -cd ../client && npm install && npm run build +cd ../client && bun install --frozen-lockfile && bun run build ``` --- @@ -316,7 +316,7 @@ tar xzf backup-pre-v3-deployments.tgz # Check out v2.1 binaries git checkout v2.1.2 cd server && npm install -cd ../client && npm install && npm run build +cd ../client && bun install --frozen-lockfile && bun run build pm2 start deploy-center ``` diff --git a/docs/v3.0-staging-verification.md b/docs/v3.0-staging-verification.md index 76dea11..f934809 100644 --- a/docs/v3.0-staging-verification.md +++ b/docs/v3.0-staging-verification.md @@ -37,7 +37,7 @@ Every row below MUST be `PASS` for the GA tag. | **SC-007** CI feedback ≤ 10 min (F-010) | Open a PR; GitHub Actions completes typecheck + lint + tests + build inside 10 minutes. | §7 | ☐ | | | | **SC-008** Template onboarding (F-008) | Create a new Node.js project from the built-in template; ≤ 3 form edits to first successful deploy. | §8 | ☐ | | | | **SC-009** v2.1 client backward compat (NFR-001) | The v2.1 client served at `/old` (or run locally) authenticates, lists projects, and triggers a deploy against the v3.0 server. | §9 | ☐ | | | -| **SC-010** Coverage gates (F-002 / F-010) | `npm test -- --coverage` ≥ 40% server lines AND `cd client && npm test -- --coverage` ≥ 30% client lines. | §7 + CI run | ☐ | | | +| **SC-010** Coverage gates (F-002 / F-010) | `npm test -- --coverage` ≥ 40% server lines AND `cd client && bun run test -- --run --coverage` ≥ 30% client lines. | §7 + CI run | ☐ | | | ---