Docs: Adds 2 references to the node.js versions we use for v3 and v4 #2118
Conversation
|
WalkthroughThe documentation was updated to provide clearer information about supported Node.js versions. A new snippet component, 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/config/config-file.mdx(2 hunks)docs/snippets/node-versions.mdx(1 hunks)docs/upgrade-to-v4.mdx(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (5)
docs/snippets/node-versions.mdx (1)
3-5: Clear and accurate version info
The bullet list succinctly communicates the Node.js versions for v3 and v4. The formatting with bold and inline code is clear, and the version numbers match the PR objectives.docs/upgrade-to-v4.mdx (2)
6-6: Consistent snippet import
Importing the<NodeVersions />component withimport NodeVersions from "/snippets/node-versions.mdx";aligns with other MDX snippet imports in this repo.
12-15: Embedding version snippet
Placing<NodeVersions />under a### Node.js 22 supportheading is clear and semantically correct (nested under## What's new in v4?). This ensures consistent documentation across the upgrade guide.docs/config/config-file.mdx (2)
9-9: Snippet import consistency
Theimport NodeVersions from "/snippets/node-versions.mdx";statement follows the existing pattern for MDX snippet imports (/snippets/...).
249-252: Node.js versions section placement
Inserting the### Node.js versionssection (rendering<NodeVersions />) between the## Runtimeand## Default machinesections is intuitive and maintains the logical flow of configuration options.
| ```ts trigger.config.ts | ||
| import { defineConfig } from "@trigger.dev/sdk/v3"; | ||
|
|
||
| export default defineConfig({ | ||
| project: "<project ref>", | ||
| // Your other config settings... | ||
| runtime: "node-22", // Uses Node.js 22.12.0 | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
Fix import path in v4 example
The code snippet uses import { defineConfig } from "@trigger.dev/sdk/v3", but since this example demonstrates configuring v4 for Node.js 22, it should import from the new v4 entrypoint (@trigger.dev/sdk). Otherwise, users upgrading to v4 may be directed to an incorrect import.
Please update the snippet as follows:
-```ts trigger.config.ts
-import { defineConfig } from "@trigger.dev/sdk/v3";
+```ts trigger.config.ts
+import { defineConfig } from "@trigger.dev/sdk";
export default defineConfig({
project: "<project ref>",
// Your other config settings...
runtime: "node-22", // Uses Node.js 22.12.0
});
<details>
<summary>🤖 Prompt for AI Agents</summary>
In docs/snippets/node-versions.mdx around lines 8 to 16, the import statement
uses the v3 SDK path "@trigger.dev/sdk/v3" but the example is for v4
configuration. Update the import to use the v4 entrypoint by changing it to
"import { defineConfig } from '@trigger.dev/sdk';" to ensure users upgrading to
v4 have the correct import path.
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
Adds a snippet to show which node.js versions we use in v3 and v4. Snippet has been added to: