Skip to content

docs: install and build the client with bun - #160

Merged
sabrydawood merged 1 commit into
masterfrom
ccr-463348c6-ulw3ws
Oct 28, 2026
Merged

sabrydawood merged 1 commit into
masterfrom
ccr-463348c6-ulw3ws

Conversation

@sabrydawood

@sabrydawood sabrydawood commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

📋 Description

The client now uses bun as its only package manager (FutureSolutionDev/Deploy-Center-Client#2). This updates the server docs that still told people to install the client with npm:

  • docs/FAQ.md and docs/migration-v2-to-v3.md: bun install --frozen-lockfile and bun run build.
  • docs/guides/GITHUB_SETUP.md: the example client CI job uses oven-sh/setup-bun, and runs install, test and lint with bun.
  • docs/v3.0-staging-verification.md: the client coverage command.

🏷️ Type of Change

  • 📝 Documentation update

🧪 How Has This Been Tested?

Docs only. The commands match the client's new CI workflow, which passed on Client #2.

Summary by CodeRabbit

  • Documentation
    • Updated client installation and build instructions to use Bun with a frozen lockfile.
    • Updated the reference CI workflow to use Bun 1.4.4 for client dependency installation, tests, and linting.
    • Updated migration and rollback instructions to use Bun for client installation and builds.
    • Updated staging verification instructions to run client coverage tests with Bun; the documented client and server coverage thresholds are unchanged.

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 <kazouya25@gmail.com>
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ⚠️ Failed 2026-10-28T11:51:40.370623Z
We couldn’t complete this review. Comment @codex review to try again.
ce00c74 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 28, 2026
@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Caution

Review failed

The pull request is closed.

Walkthrough

Client setup, migration, CI, and staging documentation now uses Bun commands for dependency installation, builds, tests, linting, and coverage.

Changes: Bun client documentation

Layer / File(s) Summary
Document Bun client commands
docs/FAQ.md, docs/migration-v2-to-v3.md, docs/guides/GITHUB_SETUP.md, docs/v3.0-staging-verification.md
Client setup and migration instructions use frozen-lockfile Bun installs and Bun builds. The client CI instructions set up Bun 1.4.4 and use Bun for installation, tests, and linting. The staging coverage command uses Bun; the server command and coverage thresholds remain unchanged.

Priority: Not assessed

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

Suggested labels: documentation

Merge Risk: Low · up to ce00c

Some documented client setup and migration paths can fail with Bun not installed; the required fixes are localized documentation updates.

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@sabrydawood
sabrydawood merged commit 49f5b7a into master Oct 28, 2026
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant