Skip to content

Commit cdadf12

Browse files
committed
Update DEVELOPER_GUIDE.md for nodejs version usage
Signed-off-by: Yulong Ruan <ruanyl@amazon.com>
1 parent 8869342 commit cdadf12

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

DEVELOPER_GUIDE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,16 @@ We recommend using [Node Version Manager (nvm)](https://github.com/nvm-sh/nvm) t
6868

6969
If it's the only version of node installed, it will automatically be set to the `default` alias. Otherwise, use `nvm list` to see all installed `node` versions, and `nvm use` to select the node version required by OpenSearch Dashboards.
7070

71+
#### Node.js version files
72+
73+
The project uses multiple files to manage the Node.js version for different purposes:
74+
75+
| File | Format | Purpose | When to update |
76+
|------|--------|---------|----------------|
77+
| `.node-version` | Exact version (e.g. `22.23.0`) | Used by the build system to download Node.js binaries for release builds | Patch, minor, and major bumps |
78+
| `.nvmrc` | Major version only (e.g. `22`) | Used by nvm and GitHub Actions CI for development | Major version bumps only |
79+
| `package.json` `engines.node` | Semver range | Validates compatible Node.js versions | Major version bumps only |
80+
7181
### Fork and clone OpenSearch Dashboards
7282

7383
All local development should be done in a [forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo).

0 commit comments

Comments
 (0)