chore: add cost-safe GitHub Codespaces devcontainer#16
chore: add cost-safe GitHub Codespaces devcontainer#16eulicesl wants to merge 1 commit intopersonal/codespaces-basefrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
📝 WalkthroughWalkthroughA new development container configuration was added: Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a .devcontainer/devcontainer.json file to standardize the development environment using Node.js 22 and Python 3.12. Feedback suggests updating the Node.js version to 24 to align with the project's README, adding Bun to the features list as per the repository's preference for TypeScript execution, and simplifying the postCreateCommand by removing redundant pnpm installation logic since corepack is enabled.
| @@ -0,0 +1,24 @@ | |||
| { | |||
| "name": "openclaw-dev", | |||
| "image": "mcr.microsoft.com/devcontainers/javascript-node:22-bookworm", | |||
There was a problem hiding this comment.
The project's README.md recommends Node 24 for the runtime. Updating the base image to 24-bookworm ensures the development environment aligns with the recommended configuration for contributors.
| "image": "mcr.microsoft.com/devcontainers/javascript-node:22-bookworm", | |
| "image": "mcr.microsoft.com/devcontainers/javascript-node:24-bookworm", |
References
- README.md recommends Node 24 or Node 22.16+ for the runtime.
| "ghcr.io/devcontainers/features/python:1": { | ||
| "version": "3.12" | ||
| } |
There was a problem hiding this comment.
The repository guidelines in AGENTS.md specify a preference for Bun for TypeScript execution (scripts, dev, tests). Adding the Bun feature ensures contributors have the preferred toolchain available in the Codespace environment.
"ghcr.io/devcontainers/features/python:1": {
"version": "3.12"
},
"ghcr.io/devcontainers/features/bun:1": {}References
- AGENTS.md states: Prefer Bun for TypeScript execution (scripts, dev, tests).
| "openFiles": ["README.md", "AGENTS.md"] | ||
| } | ||
| }, | ||
| "postCreateCommand": "corepack enable && pnpm --version || npm i -g pnpm && pnpm install" |
There was a problem hiding this comment.
Since corepack is enabled and the packageManager is explicitly defined in package.json, pnpm will be automatically managed. The manual version check and global installation fallback are redundant in this environment.
| "postCreateCommand": "corepack enable && pnpm --version || npm i -g pnpm && pnpm install" | |
| "postCreateCommand": "corepack enable && pnpm install" |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.devcontainer/devcontainer.json:
- Line 23: The postCreateCommand string has an operator-precedence bug causing
pnpm install to be skipped when corepack enable && pnpm --version succeeds;
update the postCreateCommand value so the pnpm version check and fallback
install are grouped before running pnpm install (for example, group the "pnpm
--version || npm i -g pnpm" portion with parentheses or split into separate
sequential commands) so that after ensuring pnpm is available the command always
runs pnpm install.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 310da51f-7f06-4c5a-b3fd-68c3cc37770e
📒 Files selected for processing (1)
.devcontainer/devcontainer.json
There was a problem hiding this comment.
Pull request overview
Adds a baseline GitHub Codespaces devcontainer configuration to make contributor onboarding more reproducible with cost-conscious resource defaults.
Changes:
- Introduces
.devcontainer/devcontainer.jsonusing a Node devcontainer image with Codespaces host requirements. - Adds devcontainer features for GitHub CLI and Python.
- Adds VS Code/Codespaces customizations and a dependency install
postCreateCommand.
| @@ -0,0 +1,24 @@ | |||
| { | |||
| "name": "openclaw-dev", | |||
| "image": "mcr.microsoft.com/devcontainers/javascript-node:22-bookworm", | |||
There was a problem hiding this comment.
The devcontainer pins the base image to Node 22, but the repo’s primary Docker build uses Node 24 (and CI’s setup-node defaults to 24.x). To reduce “works in Codespaces but fails in CI/Docker” drift, consider switching this image tag to the same Node major (or documenting why Codespaces should stay on 22).
| "image": "mcr.microsoft.com/devcontainers/javascript-node:22-bookworm", | |
| "image": "mcr.microsoft.com/devcontainers/javascript-node:24-bookworm", |
| }, | ||
| "customizations": { | ||
| "vscode": { | ||
| "extensions": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"] |
There was a problem hiding this comment.
The VS Code extension recommendations here don’t match the repo’s existing .vscode/extensions.json / formatter setup (which recommends oxc.oxc-vscode and uses it as the default formatter). Using ESLint/Prettier extensions in the devcontainer may lead to inconsistent formatting/linting vs the rest of the repo.
| "extensions": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"] | |
| "extensions": ["oxc.oxc-vscode"] |
| "openFiles": ["README.md", "AGENTS.md"] | ||
| } | ||
| }, | ||
| "postCreateCommand": "corepack enable && pnpm --version || npm i -g pnpm && pnpm install" |
There was a problem hiding this comment.
postCreateCommand installs dependencies without --frozen-lockfile, which can rewrite pnpm-lock.yaml during onboarding and make the Codespace non-reproducible. Also, the fallback npm i -g pnpm ignores the repo’s pinned packageManager (pnpm@10.32.1); prefer bootstrapping pnpm via corepack (or at least install the pinned pnpm version) and then run pnpm install --frozen-lockfile.
| "postCreateCommand": "corepack enable && pnpm --version || npm i -g pnpm && pnpm install" | |
| "postCreateCommand": "corepack enable && corepack prepare pnpm@10.32.1 --activate && pnpm install --frozen-lockfile" |
eulicesl
force-pushed
the
chore/codespaces-bootstrap-openclaw
branch
from
e29a92b to
db144fd
Compare
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
.devcontainer/devcontainer.json (1)
23-23:⚠️ Potential issue | 🔴 CriticalCritical:
postCreateCommandoperator chaining still skips install on success path, Sir.At Line 23,
pnpm installis not guaranteed to run whencorepack enable && pnpm --versionsucceeds.🔧 Proposed fix
- "postCreateCommand": "corepack enable && pnpm --version || npm i -g pnpm && pnpm install" + "postCreateCommand": "corepack enable && (pnpm --version || npm i -g pnpm) && pnpm install"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.devcontainer/devcontainer.json at line 23, The postCreateCommand currently uses operator chaining that causes pnpm install to be skipped when the initial corepack enable && pnpm --version succeeds; update the command in postCreateCommand so installation always runs: ensure corepack enable runs first, then try pnpm --version and fall back to npm i -g pnpm if needed, and finally always run pnpm install (e.g., by grouping the version check with || and chaining the final pnpm install with && or using semicolons); locate the postCreateCommand string and change its operator ordering to guarantee pnpm install executes on the success path.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.devcontainer/devcontainer.json:
- Line 23: Replace the non-deterministic postCreateCommand value so Corepack is
used to activate a pinned pnpm release; specifically update the
"postCreateCommand" entry to run corepack enable && corepack prepare
pnpm@<PINNED_VERSION> --activate && pnpm install (choose and pin a specific
semver like 8.6.0), rather than falling back to npm i -g pnpm, ensuring
deterministic, reproducible provisioning when the container boots.
---
Duplicate comments:
In @.devcontainer/devcontainer.json:
- Line 23: The postCreateCommand currently uses operator chaining that causes
pnpm install to be skipped when the initial corepack enable && pnpm --version
succeeds; update the command in postCreateCommand so installation always runs:
ensure corepack enable runs first, then try pnpm --version and fall back to npm
i -g pnpm if needed, and finally always run pnpm install (e.g., by grouping the
version check with || and chaining the final pnpm install with && or using
semicolons); locate the postCreateCommand string and change its operator
ordering to guarantee pnpm install executes on the success path.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: cd74a223-5237-42b3-89b1-e11aa439ac8e
📒 Files selected for processing (1)
.devcontainer/devcontainer.json
| "openFiles": ["README.md", "AGENTS.md"] | ||
| } | ||
| }, | ||
| "postCreateCommand": "corepack enable && pnpm --version || npm i -g pnpm && pnpm install" |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify current pnpm pin and bootstrap patterns used by the repo (read-only).
set -euo pipefail
echo "== packageManager / engines in package.json =="
rg -n -C2 '"packageManager"|"engines"|pnpm@' package.json
echo
echo "== standard pnpm bootstrap in scripts/install.sh =="
rg -n -C3 'corepack enable|corepack prepare|ensure_pnpm|pnpm@' scripts/install.sh
echo
echo "== CI setup pattern references =="
rg -n -C3 'setup-pnpm-store-cache|pnpm-version|pnpm -v' .github/actions/setup-node-env/action.yml
echo
echo "== current devcontainer command =="
rg -n -C1 '"postCreateCommand"' .devcontainer/devcontainer.jsonRepository: eulicesl/openclaw
Length of output: 1782
🌐 Web query:
corepack prepare pnpm activate best practices Node.js
💡 Result:
To prepare and activate pnpm using Corepack in Node.js projects, follow these best practices grounded in official documentation: 1. Update Corepack to the latest version due to signature issues: npm install --global corepack@latest 2. Enable Corepack for pnpm: corepack enable pnpm This creates shims for pnpm/pnpx next to the Node.js binary. 3. For project-specific version pinning (recommended for reproducibility), add to package.json: "packageManager": "pnpm@latest-10" Then run: corepack use pnpm@latest-10 Corepack will automatically download and use this version when pnpm is invoked in the project. 4. For CI/CD and Docker (offline-safe preparation): npm install --global corepack@latest corepack enable corepack prepare pnpm@latest-10 --activate This installs and activates the specific version globally in the environment. Key benefits: - Ensures all team members and CI use the exact same pnpm version. - No global pnpm installs needed; avoids conflicts. - In CI, pnpm auto-uses frozen-lockfile mode. Avoid: Global npm install -g pnpm (overrides Corepack shims). Use corepack pnpm ... if shims conflict. Note: Node.js >=16.13 includes Corepack (experimental; enable required). For Node 26+, may need userland Corepack.
Citations:
- 1: https://pnpm.io/continuous-integration
- 2: https://pnpm.io/next/installation
- 3: https://pnpm.io/installation
- 4: https://nodejs.org/download/release/v22.11.0/docs/api/corepack.html
- 5: https://corepack.org/
- 6: https://pnpm.io/en/installation
- 7: https://pnpm.io/9.x/continuous-integration
- 8: https://pnpm.io/next/continuous-integration
🌐 Web query:
devcontainer postCreateCommand pnpm corepack bootstrap
💡 Result:
To set up pnpm with Corepack in a VS Code Dev Container using postCreateCommand, use the following configuration in your .devcontainer/devcontainer.json file. This enables Corepack (which ships with Node.js) to manage pnpm, ensuring the correct version is used based on your package.json's "packageManager" field. Example devcontainer.json snippet: { "image": "mcr.microsoft.com/devcontainers/javascript-node:20", "features": { "ghcr.io/devcontainers/features/node:1": { "version": "20" } }, "postCreateCommand": "corepack enable && corepack prepare pnpm@latest --activate && pnpm install", "customizations": { "vscode": { "extensions": ["esbenp.prettier-vscode"] } } } Key steps in postCreateCommand: 1. corepack enable - Activates Corepack shims for package managers like pnpm. 2. corepack prepare pnpm@latest --activate - Downloads and activates the specified pnpm version (use the version from your package.json, e.g., "pnpm@10.5.0"). 3. pnpm install - Installs dependencies using the activated pnpm. For Dockerfiles in .devcontainer/Dockerfile, do this during build: FROM mcr.microsoft.com/devcontainers/javascript-node:20 RUN corepack enable pnpm ENV PNPM_HOME=/pnpm ENV PATH="$PNPM_HOME:$PATH" Then in devcontainer.json: "postCreateCommand": "pnpm install --frozen-lockfile" To persist pnpm store across rebuilds (faster installs), add mounts: "mounts": [ "source=pnpm-store,target=${containerWorkspaceFolder}/.pnpm-store,type=volume" ], "postCreateCommand": "corepack enable pnpm && sudo chown -R $(whoami) .pnpm-store && pnpm install" This setup works with Node.js 20+ images where Corepack is included. For Node 25+, Corepack may need npm install -g corepack@latest first, but devcontainer Node images use versions with Corepack. pnpm official repo has .devcontainer config at github.com/pnpm/pnpm/tree/main/.devcontainer confirming this approach.
Citations:
- 1: https://stackoverflow.com/questions/77099690/how-do-i-make-pnpm-work-as-intended-in-a-vscode-dev-container
- 2: https://opensource.unicc.org/openwallet-foundation/credo-ts/-/blob/v0.6.0-alpha-20250311103137/.devcontainer/devcontainer.json
- 3: https://pnpm.io/9.x/docker
- 4: https://pnpm.io/next/installation
- 5: https://pnpm.io/installation
- 6: https://github.com/pnpm/pnpm/tree/main/.devcontainer
- 7: https://gist.github.com/PatrickChoDev/81d36159aca4dc687b8c89983e64da2e?permalink_comment_id=5782142
- 8: https://github.com/coveo/ui-kit/blob/main/.devcontainer/README.md
Major: pnpm provisioning at Line 23 presents a determinism vulnerability, Sir.
The current command—corepack enable && pnpm --version || npm i -g pnpm && pnpm install—lacks explicit version pinning and will fail on initial container setup. The fallback npm i -g pnpm bypasses Corepack entirely, pulling an arbitrary version from the registry. Official Corepack and pnpm documentation for containerised environments prescribe the pattern: corepack enable && corepack prepare pnpm@VERSION --activate.
Recommend aligning with deterministic bootstrap practices:
🔧 Proposed deterministic bootstrap
- "postCreateCommand": "corepack enable && pnpm --version || npm i -g pnpm && pnpm install"
+ "postCreateCommand": "corepack enable && corepack prepare pnpm@10.32.1 --activate && pnpm install"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "postCreateCommand": "corepack enable && pnpm --version || npm i -g pnpm && pnpm install" | |
| "postCreateCommand": "corepack enable && corepack prepare pnpm@10.32.1 --activate && pnpm install" |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.devcontainer/devcontainer.json at line 23, Replace the non-deterministic
postCreateCommand value so Corepack is used to activate a pinned pnpm release;
specifically update the "postCreateCommand" entry to run corepack enable &&
corepack prepare pnpm@<PINNED_VERSION> --activate && pnpm install (choose and
pin a specific semver like 8.6.0), rather than falling back to npm i -g pnpm,
ensuring deterministic, reproducible provisioning when the container boots.
|
Closing this as redundant after moving the personal Codespaces setup to fork-only branch |
Summary
Add a baseline GitHub Codespaces devcontainer with cost-safe defaults for contributor onboarding.
Defaults
Why
Makes cloud dev reproducible and quick while controlling spend.
Summary by CodeRabbit