Conversation
There was a problem hiding this comment.
Pull request overview
Updates developer documentation to reflect a higher minimum Node.js version during local environment setup.
Changes:
- Bumps the documented Node.js minimum version in the development setup guide from 20 to 22.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
The problem indeed goes deeper than just the docs say. I will update the PR to also change the engine in other places. |
|
I fixed it up everywhere, it should be good to go. |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
Suppressed comments (2)
DEVELOPMENT.md:142
- This line says “at least Node 22”, but the repo now enforces
engines.node >=22.12.0(andelectron@43.3.0requires that exact minimum). As written, someone installing 22.0–22.11 would still failpnpm install. Please specify the same minimum patch version here to match the enforced requirement.
Next, ensure you've got at least Node 22 installed. If you're on Mac OS or Linux and you're missing `node`, you can use your favorite package manager like `brew` or `apt`.
e2e/README.md:22
- For consistency with the enforced
engines.node >=22.12.0, consider making this requirement explicit asv22.12.0+(instead ofv22.12+). That avoids ambiguity about whether 22.0.0 would work.
1. **Node.js** (v22.12+): See [DEVELOPMENT.md](../DEVELOPMENT.md) for installation
|
Heyyo @Byron anything else I need to do here? |
|
Thanks, this looks good to me, despite the conflict. |
|
Hey @masecla22! I bumped us to the latest LTS this week (v24), but it looks like I missed some of the documentation you covered. Would you like to update it / is v24 working okay for you? |
There was a problem hiding this comment.
🟡 Changes recommended
The Node/pnpm version requirements are inconsistent across package.json, DEVELOPMENT.md, and e2e/README.md (and the PR title), which will confuse setup and enforcement.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Review details
Suppressed comments (1)
DEVELOPMENT.md:142
- This doc says “at least Node 22”, but the repo’s enforced minimum is >=22.12.0 via package.json engines (and Electron’s engines constraint). Consider documenting the patch-level minimum to reduce setup churn.
Next, ensure you've got at least Node 22 installed. If you're on Mac OS or Linux and you're missing `node`, you can use your favorite package manager like `brew` or `apt`.
- Files reviewed: 3/3 changed files
- Comments generated: 2
- Review effort level: Lite
| 1. **Node.js** (v24+): See [DEVELOPMENT.md](../DEVELOPMENT.md) for installation | ||
| 2. **pnpm** (v10.17.0): Enabled via `corepack enable` in the project root |
| "engines": { | ||
| "node": ">=20.11" | ||
| "node": ">=22.12.0" | ||
| }, |
|
Think this is all folded into 0b65136 now. Thanks for raising! |
Caught in gitbutlerapp#15391.
🧢 Changes
While setting up my development environment (for fixing a different issue), I noticed that Node 20 is in fact insufficient, even though the docs say that 20 should be enough. Changing to 22, since thats what the package.json says should be used.