chore: update the min required node version in client setup guide.#37380
chore: update the min required node version in client setup guide.#37380shubham88fru wants to merge 1 commit intoappsmithorg:releasefrom
Conversation
WalkthroughThe pull request updates the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
contributions/ClientSetup.md (2)
Line range hint
11-18: Add Node.js version requirement to prerequisites.The Node.js version requirement (20.11.1) should be listed in the prerequisites section to ensure users have the correct version before starting the setup process.
Add this line after the existing prerequisites:
1. You have `envsubst` installed. Use `brew install gettext` on MacOS. Linux machines usually have this installed. +1. You have Node.js version 20.11.1 or higher installed. We recommend using a node version manager like `nvm` or `fnm`. 1. You have cloned the repo in your local machine.
Line range hint
93-98: Document the Node.js version mismatch error message.To help users quickly identify the version mismatch issue, include the actual error message they might encounter.
Add the error message example:
1. If yarn start throws mismatch node version error + ``` + error Appsmith requires Node.js version 20.11.1 or higher + info Current version: 18.x.x + ``` - This error occurs because the node version is not compatible with the app environment.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
contributions/ClientSetup.md(1 hunks)
🔇 Additional comments (1)
contributions/ClientSetup.md (1)
97-97: LGTM on Node.js version update.
The update to Node.js version 20.11.1 matches the PR objectives.
Let's verify version consistency across the documentation:
✅ Verification successful
Node.js version is correctly specified in package.json and setup instructions
The Node.js version 20.11.1 is correctly specified in:
- package.json
enginesfield:"node": "^20.11.1" - ClientSetup.md setup instructions
The documentation accurately reflects the required Node.js version and provides appropriate guidance for version management using nvm/fnm.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for any other Node.js version references
rg -i "node.*?(?:18|20|version)" contributions/ClientSetup.md
Length of output: 442
Script:
#!/bin/bash
# Search for any Node.js version references in package.json and other config files
rg -i "node.*?(?:18|20|version)" package.json .nvmrc .node-version 2>/dev/null
# Search for any engine requirements in package.json
rg -i '"engines"' -A 5 package.json 2>/dev/null
Length of output: 106
Script:
#!/bin/bash
# Find package.json files recursively and check their content
fd -t f "package.json" -x cat {}
# Find any .nvmrc or .node-version files
fd -t f "(.nvmrc|.node-version)" -x cat {}
Length of output: 27746
|
This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected. |
|
This PR has been closed because of inactivity. |
1 participant
Description
The
ClientSetup.mdfile still suggests to use node version 18.x to run the client code, however, as per the latest project requirements, node version ^20.11.1 is required.Fixes #37379
Fix
Updated the
ClientSetup.mdfile to reflect the correct minimum required node version.Automation
/ok-to-test tags=""
🔍 Cypress test results
Caution
If you modify the content in this section, you are likely to disrupt the CI result for your PR.
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit
mkcertwith specific commands for Linux users.