Skip to content

Commit 7c91341

Browse files
committed
coderabbit changes
1 parent 8e0a3a9 commit 7c91341

File tree

1 file changed

+38
-19
lines changed

1 file changed

+38
-19
lines changed

docs/vercel-integration.mdx

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ The Vercel integration connects your Vercel project to your Trigger.dev project
1010
This eliminates the need to manually run the `trigger.dev deploy` command or maintain custom CI/CD workflows for Vercel-based projects.
1111

1212
<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.
1415
</Note>
1516

1617
## Installation
@@ -22,23 +23,27 @@ You can connect Vercel from two entry points:
2223
<Steps>
2324

2425
<Step title="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.
2628
</Step>
2729

2830
<Step title="Select a Vercel project">
2931
Choose which Vercel project to connect to your Trigger.dev project.
3032
</Step>
3133

3234
<Step title="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.
3437
</Step>
3538

3639
<Step title="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.
3842
</Step>
3943

40-
<Step title="Configure build settings">
41-
Optionally adjust [build settings](#build-settings) for atomic deployments, env var pulling, and new env var discovery.
44+
<Step title="Configure build options">
45+
Optionally adjust [build options](#build-options) for atomic deployments, env var pulling, and new
46+
env var discovery.
4247
</Step>
4348

4449
<Step title="Connect GitHub">
@@ -52,11 +57,14 @@ You can connect Vercel from two entry points:
5257
<Steps>
5358

5459
<Step title="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.
5663
</Step>
5764

5865
<Step title="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.
6068
</Step>
6169

6270
<Step title="Connect GitHub">
@@ -66,11 +74,17 @@ You can connect Vercel from two entry points:
6674
</Steps>
6775

6876
<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.
7079
</Note>
7180

7281
<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.
7488
</Warning>
7589

7690
## Environment variable sync
@@ -82,13 +96,15 @@ The integration syncs environment variables in both directions:
8296
**Trigger.dev → Vercel**: Trigger.dev syncs API keys (like `TRIGGER_SECRET_KEY`) to your Vercel project so your app can communicate with Trigger.dev.
8397

8498
The following variables are excluded from the Vercel → Trigger.dev sync:
99+
85100
- `TRIGGER_SECRET_KEY`, `TRIGGER_VERSION`, `TRIGGER_PREVIEW_BRANCH` (managed by Trigger.dev)
86101
- Sensitive/secret-type variables (Vercel API limitation)
87102

88103
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.
89104

90105
<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).
92108
</Tip>
93109

94110
## Atomic deployments
@@ -98,7 +114,9 @@ Atomic deployments ensure your Vercel app and Trigger.dev tasks are deployed in
98114
Atomic deployments are enabled for the production environment by default.
99115

100116
<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.
102120
</Note>
103121

104122
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
107125

108126
The integration maps Vercel environments to Trigger.dev environments:
109127

110-
| Vercel environment | Trigger.dev environment |
111-
| --- | --- |
112-
| Production | Production |
128+
| Vercel environment | Trigger.dev environment |
129+
| ------------------ | ------------------------------ |
130+
| Production | Production |
113131
| Custom environment | Staging (you choose which one) |
114-
| Preview | Preview |
115-
| Development | Development |
132+
| Preview | Preview |
133+
| Development | Development |
116134

117135
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.
118136

119137
<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).
121140
</Note>
122141

123-
## Build settings
142+
## Build options
124143

125144
You can configure the following settings per-environment from your project's Vercel settings:
126145

0 commit comments

Comments
 (0)