Skip to content

Commit 81cb463

Browse files
committed
WIP upgrade to v4 docs
1 parent cb6d697 commit 81cb463

File tree

2 files changed

+137
-16
lines changed

2 files changed

+137
-16
lines changed

docs/docs.json

Lines changed: 48 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,24 @@
1818
"groups": [
1919
{
2020
"group": "Getting started",
21-
"pages": ["introduction", "quick-start", "video-walkthrough", "how-it-works", "limits"]
21+
"pages": [
22+
"introduction",
23+
"quick-start",
24+
"video-walkthrough",
25+
"how-it-works",
26+
"limits"
27+
]
2228
},
2329
{
2430
"group": "Fundamentals",
2531
"pages": [
2632
{
2733
"group": "Tasks",
28-
"pages": ["tasks/overview", "tasks/schemaTask", "tasks/scheduled"]
34+
"pages": [
35+
"tasks/overview",
36+
"tasks/schemaTask",
37+
"tasks/scheduled"
38+
]
2939
},
3040
"triggering",
3141
"runs",
@@ -40,7 +50,12 @@
4050
"errors-retrying",
4151
{
4252
"group": "Wait",
43-
"pages": ["wait", "wait-for", "wait-until", "wait-for-token"]
53+
"pages": [
54+
"wait",
55+
"wait-for",
56+
"wait-until",
57+
"wait-for-token"
58+
]
4459
},
4560
"queue-concurrency",
4661
"versioning",
@@ -84,7 +99,9 @@
8499
},
85100
{
86101
"group": "Development",
87-
"pages": ["cli-dev"]
102+
"pages": [
103+
"cli-dev"
104+
]
88105
},
89106
{
90107
"group": "Deployment",
@@ -95,7 +112,9 @@
95112
"deployment/atomic-deployment",
96113
{
97114
"group": "Deployment integrations",
98-
"pages": ["vercel-integration"]
115+
"pages": [
116+
"vercel-integration"
117+
]
99118
}
100119
]
101120
},
@@ -146,15 +165,20 @@
146165
},
147166
{
148167
"group": "Using the Dashboard",
149-
"pages": ["run-tests", "troubleshooting-alerts", "replaying", "bulk-actions"]
168+
"pages": [
169+
"run-tests",
170+
"troubleshooting-alerts",
171+
"replaying",
172+
"bulk-actions"
173+
]
150174
},
151175
{
152176
"group": "Troubleshooting",
153177
"pages": [
154178
"troubleshooting",
155179
"troubleshooting-debugging-in-vscode",
156180
"upgrading-packages",
157-
"upgrading-beta",
181+
"upgrade-to-v4",
158182
"troubleshooting-uptime-status",
159183
"troubleshooting-github-issues",
160184
"request-feature"
@@ -172,7 +196,11 @@
172196
},
173197
{
174198
"group": "Help",
175-
"pages": ["community", "help-slack", "help-email"]
199+
"pages": [
200+
"community",
201+
"help-slack",
202+
"help-email"
203+
]
176204
}
177205
]
178206
},
@@ -193,7 +221,10 @@
193221
},
194222
{
195223
"group": "Tasks API",
196-
"pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
224+
"pages": [
225+
"management/tasks/trigger",
226+
"management/tasks/batch-trigger"
227+
]
197228
},
198229
{
199230
"group": "Runs API",
@@ -239,7 +270,9 @@
239270
"groups": [
240271
{
241272
"group": "Introduction",
242-
"pages": ["guides/introduction"]
273+
"pages": [
274+
"guides/introduction"
275+
]
243276
},
244277
{
245278
"group": "Frameworks",
@@ -363,7 +396,10 @@
363396
"href": "https://trigger.dev"
364397
},
365398
"api": {
366-
"openapi": ["openapi.yml", "v3-openapi.yaml"],
399+
"openapi": [
400+
"openapi.yml",
401+
"v3-openapi.yaml"
402+
],
367403
"playground": {
368404
"display": "simple"
369405
}
@@ -538,4 +574,4 @@
538574
"destination": "/management/overview"
539575
}
540576
]
541-
}
577+
}

docs/upgrade-to-v4.mdx

Lines changed: 89 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,93 @@
11
---
22
title: "Upgrading to v4"
3-
description: "How to upgrade to v4."
3+
description: "What's new in v4, how to upgrade, and breaking changes."
44
---
55

6-
<Note>
7-
Upgrading to v4 docs are coming soon.
8-
</Note>
6+
## What's new in v4?
7+
8+
Link to blog post here
9+
10+
- New Run Engine
11+
- Wait tokens
12+
- Upgraded Dashboard
13+
- Wait idempotency
14+
- Priority
15+
- Queues
16+
- New global lifecycle hooks
17+
- onPause and onResume
18+
- Improved middleware
19+
- locals
20+
- Improved tracing
21+
- MCP Server
22+
- Exporting tasks or queues
23+
24+
## Installation
25+
26+
To opt-in to using v4, you will need to update your dependencies to the latest version of the `v4` tag.
27+
28+
<CodeGroup>
29+
30+
```bash npm
31+
npm add @trigger.dev/sdk@v4
32+
```
33+
34+
```bash yarn
35+
yarn add @trigger.dev/sdk@v4
36+
```
37+
38+
```bash pnpm
39+
pnpm add @trigger.dev/sdk@v4
40+
```
41+
42+
</CodeGroup>
43+
44+
You'll also need to use the `v4` version of the `trigger.dev` CLI package:
45+
46+
<CodeGroup>
47+
48+
```bash npx
49+
npx trigger.dev@v4 dev
50+
```
51+
52+
```bash yarn
53+
yarn dlx trigger.dev@v4 dev
54+
```
55+
56+
```bash pnpm
57+
pnpm dlx trigger.dev@v4 dev
58+
```
59+
60+
</CodeGroup>
61+
62+
Or you could install the CLI into your `devDependencies` and then use the `trigger` binary:
63+
64+
```json package.json
65+
{
66+
"devDependencies": {
67+
"trigger.dev": "v4"
68+
},
69+
"scripts": {
70+
"dev": "trigger dev"
71+
}
72+
}
73+
```
74+
75+
## Deprecations
76+
77+
### Import `@trigger.dev/sdk`
78+
79+
### toolTask
80+
81+
## Breaking changes
82+
83+
### Queue changes
84+
85+
### `releaseConcurrency`
86+
87+
### Lifecycle hooks
88+
89+
### Context changes
90+
91+
## Migrating to the new run engine
92+
93+
New runs after you deploy with

0 commit comments

Comments
 (0)