Repository navigation
docs: fix outdated Node 24 warnings in TROUBLESHOOTING.md - #1343
diegosouzapw merged 2 commits into
Conversation
Address Gemini code review feedback on PR diegosouzapw#1340: - Remove outdated 'Node.js 24+ not supported' warnings from lines 18, 32, 52 - Update Quick Fixes table to remove Node 24 reference - Update Node.js Compatibility section to reflect Node 24 support - Update recommended version to Node 24 in fix instructions - Pin Dockerfile base images to 24.14.1 for reproducibility - Clarify SUPPORTED_NODE_DISPLAY to show '24.0.0+' minimum All documentation now consistent with Node 24 LTS support.
There was a problem hiding this comment.
Code Review
This pull request updates the project to officially support and recommend Node.js 24.x. Key changes include pinning the Docker base image to Node 24.14.1, updating the troubleshooting documentation to reflect Node 24 compatibility, and refining runtime support utility strings. The review feedback suggests minor documentation improvements to ensure consistency regarding Node 24's status and to clarify that the recommended version verification applies specifically to the 24.x LTS line.
|
|
||
| 1. **Node.js 24+**: `better-sqlite3` is not supported here and startup can fail hard. | ||
| 2. **Older Node 20/22 patch levels**: the runtime may start, but it falls below the patched security floor OmniRoute now requires. | ||
| **Cause:** You are running a Node.js version outside OmniRoute's approved secure runtime floor. The most common case is running an older Node 20/22 patch level that falls below the patched security floor OmniRoute requires. |
There was a problem hiding this comment.
The description of the "most common case" for Node.js version issues should be updated to include Node 24, as it is now a supported and recommended version. This ensures the documentation remains consistent with the changes made elsewhere in this PR.
| **Cause:** You are running a Node.js version outside OmniRoute's approved secure runtime floor. The most common case is running an older Node 20/22 patch level that falls below the patched security floor OmniRoute requires. | |
| **Cause:** You are running a Node.js version outside OmniRoute's approved secure runtime floor. The most common case is running an older Node 20, 22, or 24 patch level that falls below the patched security floor OmniRoute requires. |
| nvm use 24 | ||
| ``` | ||
| 2. Verify your version: `node --version` should show `v22.22.2` or newer on the 22.x LTS line | ||
| 2. Verify your version: `node --version` should show `v24.0.0` or newer |
There was a problem hiding this comment.
The verification step should specify that the version should be on the 24.x line. Without this clarification, "v24.0.0 or newer" could be interpreted as including Node 25+, which is explicitly excluded from the supported range (<25) and the engines field in package.json.
| 2. Verify your version: `node --version` should show `v24.0.0` or newer | |
| 2. Verify your version: node --version should show v24.0.0 or newer on the 24.x LTS line |
- Clarify that Node 24 patch levels can also fall below security floor - Specify verification should be on 24.x LTS line to avoid confusion with Node 25+
Gemini Review Addressed ✅Applied both suggestions from the code review:
This prevents confusion with Node 25+ which is explicitly excluded from the supported range. Commit: |
|
Thanks @oyi77 for this great contribution! 🎉 This PR has been evaluated and successfully integrated into the release/v3.6.7 branch and will be part of the final production release. We appreciate your effort! |
…pw#1343) Integrated into release/v3.6.7
…pw#1343) Integrated into release/v3.6.7
Summary
Address Gemini code review feedback from PR #1340 by removing outdated Node.js 24 warnings and improving documentation consistency.
Changes
Documentation Fixes
Code Improvements
node:24.14.1-trixie-slimfor build reproducibilitySUPPORTED_NODE_DISPLAYto show24.0.0+minimum versionContext
This PR addresses all 4 review comments from Gemini on PR #1340:
Testing
Documentation changes only — no functional changes to code.
Related