Update system-requirements.md#17581
Update system-requirements.md#17581mpysiak merged 1 commit intoSylius:2.0from tomkalon:fix/docs-system-requirements
Conversation
WalkthroughThe documentation for system requirements has been updated to modify the supported Node.js versions. The change reflects an expansion of compatible Node.js versions, removing support for version 18 and adding support for version 22, while maintaining version 20 as a supported option. Changes
Poem
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
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/the-book/installation/system-requirements.md (1)
10-10: LGTM, but consider adding migration notesThe Node.js version update is technically accurate and aligns with the @sylius-ui/admin@2.0.0 module requirements. However, since this is a breaking change that removes support for Node.js 18, consider adding a note about migration path for existing installations.
Consider adding a note below the requirements table:
| [Node.js](https://nodejs.org/en) `^20 || ^22` | | Git | +{% hint style="warning" %} +**Note:** If you're upgrading from a previous version using Node.js 18, you'll need to upgrade to Node.js 20 or 22 to ensure compatibility with @sylius-ui/admin@2.0.0. +{% endhint %} {% hint style="info" %}
| | [Composer](https://getcomposer.org/download/) | | ||
| | <p>One of the supported database engines:</p><ul><li>MySQL <code>8.0</code> or higher</li><li>MariaDB <code>10.4.10</code> or higher</li><li>PostgreSQL <code>13.9</code> or higher</li></ul> | | ||
| | [Node.js](https://nodejs.org/en) `^18 \|\| ^20` | | ||
| | [Node.js](https://nodejs.org/en) `^20 \|\| ^22` | |
There was a problem hiding this comment.
💡 Codebase verification
Node.js 22 requirement should be removed at this time
The current @sylius-ui/admin package officially supports Node.js 18 and 20, but not Node.js 22. Additionally, Node.js 22 is not yet released (scheduled for April 24, 2024) and won't reach LTS status until October 29, 2024. It's premature to list it as a system requirement.
- Remove Node.js 22 from the requirements and keep only Node.js 20
- Consider adding Node.js 22 support after it reaches LTS status in October 2024
🔗 Analysis chain
Verify Node.js 22 compatibility status
Since Node.js 22 is currently in development/beta status, we should verify if it's appropriate to recommend it in production requirements.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check Node.js 22 release status and @sylius-ui/admin compatibility
# Check latest @sylius-ui/admin package.json for Node.js engine requirements
curl -s https://registry.npmjs.org/@sylius-ui/admin/latest | jq '.engines.node'
# Check Node.js 22 release schedule and status
curl -s https://raw.githubusercontent.com/nodejs/Release/main/schedule.json | jq '.["v22"]'
Length of output: 312
Bunnyshell Preview Environment deployedIt will be automatically stopped in 4 hours. Use the command
Available commands:
|
Sylius 2.0
Changed system requirements:
NodeJS 18.x || 20.x
to:
NodeJS 20.x || 22.x
Summary by CodeRabbit
^18 || ^20to^20 || ^22.