docs: add note about SSR when deploying to Amplify#3719
Conversation
|
@nimonian is attempting to deploy a commit to the Nuxt Team on Vercel. A member of the Team first needs to authorize it. |
commit: |
📝 WalkthroughWalkthroughThis pull request adds a warning block to the AWS Amplify deployment documentation that clarifies a Node.js version requirement when using Server-Side Rendering (SSR) with node:sqlite. The warning informs developers that Amplify's default Node 20 runtime is insufficient and must be explicitly configured to Node 22.x via the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/content/docs/6.deploy/8.aws-amplify.md (2)
38-48: Consider clarifying the build vs. runtime environment distinction.The warning explains the runtime configuration requirement, which is distinct from the build environment configuration shown in lines 22-36. To help readers understand this important distinction more clearly, consider adding a brief note that emphasizes this is about the runtime environment (where SSR executes), not the build environment (where the app is compiled).
For example:
::warning If you are using SSR for content, Nitro defaults the Amplify **runtime environment** (where SSR executes) to Node 20, even if your build environment uses Node 22. Since `node:sqlite` requires Node 22+, you need to explicitly set the runtime version in `nuxt.config.ts`:
39-39: Consider clarifying "using SSR for content."The phrase "using SSR for content" might be interpreted differently by readers. Consider being more explicit, such as "when using Server-Side Rendering with Nuxt Content" or "when SSR is enabled and querying content at runtime."
🔗 Linked issue
#3718
❓ Type of change
📚 Description
Resolves #3718
Ensures that users using SSR are advised to set the correct runtime version for Node in AWS Amplify deployments.
📝 Checklist