You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/vercel-integration.mdx
+38-19Lines changed: 38 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,8 @@ The Vercel integration connects your Vercel project to your Trigger.dev project
10
10
This eliminates the need to manually run the `trigger.dev deploy` command or maintain custom CI/CD workflows for Vercel-based projects.
11
11
12
12
<Note>
13
-
The Vercel integration requires the [GitHub integration](/github-integration) to be connected as well, since Trigger.dev builds your tasks from your GitHub repository.
13
+
The Vercel integration requires the [GitHub integration](/github-integration) to be connected as
14
+
well, since Trigger.dev builds your tasks from your GitHub repository.
14
15
</Note>
15
16
16
17
## Installation
@@ -22,23 +23,27 @@ You can connect Vercel from two entry points:
22
23
<Steps>
23
24
24
25
<Steptitle="Connect Vercel">
25
-
Go to your project's **Settings** page and click **Connect Vercel**. This will redirect you to Vercel to authorize the Trigger.dev app.
26
+
Go to your project's **Settings** page and click **Connect Vercel**. This will redirect you to
27
+
Vercel to authorize the Trigger.dev app.
26
28
</Step>
27
29
28
30
<Steptitle="Select a Vercel project">
29
31
Choose which Vercel project to connect to your Trigger.dev project.
30
32
</Step>
31
33
32
34
<Steptitle="Map environments">
33
-
If your Vercel project has custom environments, choose which one maps to your Trigger.dev staging environment.
35
+
If your Vercel project has custom environments, choose which one maps to your Trigger.dev staging
36
+
environment.
34
37
</Step>
35
38
36
39
<Steptitle="Sync environment variables">
37
-
Review the environment variables that will be pulled from Vercel into Trigger.dev. You can deselect any variables you don't want to sync.
40
+
Review the environment variables that will be pulled from Vercel into Trigger.dev. You can
41
+
deselect any variables you don't want to sync.
38
42
</Step>
39
43
40
-
<Steptitle="Configure build settings">
41
-
Optionally adjust [build settings](#build-settings) for atomic deployments, env var pulling, and new env var discovery.
44
+
<Steptitle="Configure build options">
45
+
Optionally adjust [build options](#build-options) for atomic deployments, env var pulling, and new
46
+
env var discovery.
42
47
</Step>
43
48
44
49
<Steptitle="Connect GitHub">
@@ -52,11 +57,14 @@ You can connect Vercel from two entry points:
52
57
<Steps>
53
58
54
59
<Steptitle="Install the integration">
55
-
Install the [Trigger.dev integration from the Vercel Marketplace](https://vercel.com/marketplace/trigger). This will redirect you to Trigger.dev to complete setup.
60
+
Install the [Trigger.dev integration from the Vercel
61
+
Marketplace](https://vercel.com/marketplace/trigger). This will redirect you to Trigger.dev to
62
+
complete setup.
56
63
</Step>
57
64
58
65
<Steptitle="Select your Trigger.dev organization and project">
59
-
Choose which Trigger.dev organization and project to connect. If you're new to Trigger.dev, you'll be guided through creating an organization and project.
66
+
Choose which Trigger.dev organization and project to connect. If you're new to Trigger.dev, you'll
67
+
be guided through creating an organization and project.
60
68
</Step>
61
69
62
70
<Steptitle="Connect GitHub">
@@ -66,11 +74,17 @@ You can connect Vercel from two entry points:
66
74
</Steps>
67
75
68
76
<Note>
69
-
When installing from the Vercel Marketplace, default build settings are applied automatically. You can adjust them later in your project settings.
77
+
When installing from the Vercel Marketplace, default build settings are applied automatically. You
78
+
can adjust them later in your project settings.
70
79
</Note>
71
80
72
81
<Warning>
73
-
**Vercel Root Directory:** If your Vercel project uses a **Root Directory** (e.g. you deploy a single subfolder such as `app` or `web`), you may see "The specified Root Directory does not exist" after connecting the integration. Use the **repository root** (leave Root Directory empty) in your Vercel project settings instead. Trigger.dev always builds from the repo root; point to your app or tasks in a subfolder by setting the **Trigger config file** path (and other [Build options](#build-settings)) in your Trigger.dev project configuration.
82
+
**Vercel Root Directory:** If your Vercel project uses a **Root Directory** (e.g. you deploy a
83
+
single subfolder such as `app` or `web`), you may see "The specified Root Directory does not
84
+
exist" after connecting the integration. Use the **repository root** (leave Root Directory empty)
85
+
in your Vercel project settings instead. Trigger.dev always builds from the repo root; point to
86
+
your app or tasks in a subfolder by setting the **Trigger config file** path (and other [Build
87
+
options](#build-options)) in your Trigger.dev project configuration.
74
88
</Warning>
75
89
76
90
## Environment variable sync
@@ -82,13 +96,15 @@ The integration syncs environment variables in both directions:
82
96
**Trigger.dev → Vercel**: Trigger.dev syncs API keys (like `TRIGGER_SECRET_KEY`) to your Vercel project so your app can communicate with Trigger.dev.
83
97
84
98
The following variables are excluded from the Vercel → Trigger.dev sync:
99
+
85
100
-`TRIGGER_SECRET_KEY`, `TRIGGER_VERSION`, `TRIGGER_PREVIEW_BRANCH` (managed by Trigger.dev)
86
101
- Sensitive/secret-type variables (Vercel API limitation)
87
102
88
103
You can control sync behavior per-variable from your project's Vercel settings. Deselecting a variable prevents its value from being updated during future syncs.
89
104
90
105
<Tip>
91
-
For dynamic environment variables (e.g., from NeonDB branching), use the `syncEnvVars` build extension instead. Learn more about [environment variables](/deploy-environment-variables).
106
+
For dynamic environment variables (e.g., from NeonDB branching), use the `syncEnvVars` build
107
+
extension instead. Learn more about [environment variables](/deploy-environment-variables).
92
108
</Tip>
93
109
94
110
## Atomic deployments
@@ -98,7 +114,9 @@ Atomic deployments ensure your Vercel app and Trigger.dev tasks are deployed in
98
114
Atomic deployments are enabled for the production environment by default.
99
115
100
116
<Note>
101
-
When atomic deployments are enabled, the integration automatically disables `Auto-assign Custom Production Domains` on your Vercel project. This is required so that Vercel doesn't promote a deployment before the Trigger.dev build is ready.
117
+
When atomic deployments are enabled, the integration automatically disables `Auto-assign Custom
118
+
Production Domains` on your Vercel project. This is required so that Vercel doesn't promote a
119
+
deployment before the Trigger.dev build is ready.
102
120
</Note>
103
121
104
122
Previously, setting up atomic deployments with Vercel required custom GitHub Actions workflows. The Vercel integration automates this entirely. For more details on how atomic deployments work, see [Atomic deploys](/deployment/atomic-deployment).
@@ -107,20 +125,21 @@ Previously, setting up atomic deployments with Vercel required custom GitHub Act
107
125
108
126
The integration maps Vercel environments to Trigger.dev environments:
| Custom environment | Staging (you choose which one) |
114
-
| Preview | Preview |
115
-
| Development | Development |
132
+
| Preview | Preview|
133
+
| Development | Development|
116
134
117
135
If your Vercel project has a custom environment, you can select which one maps to your Trigger.dev staging environment during setup or in your project settings.
118
136
119
137
<Note>
120
-
Preview deployments require the preview environment to be enabled on your project. Learn more about [preview branches](/deployment/preview-branches).
138
+
Preview deployments require the preview environment to be enabled on your project. Learn more
139
+
about [preview branches](/deployment/preview-branches).
121
140
</Note>
122
141
123
-
## Build settings
142
+
## Build options
124
143
125
144
You can configure the following settings per-environment from your project's Vercel settings:
0 commit comments