Skip to content

Commit 21fdb52

Browse files
authored
docs: deprecate syncVercelEnvVars extension and add conflict warning (#3208)
Deprecates the syncVercelEnvVars build extension and adds warnings in both the Vercel integration docs and the extension's own page to prevent conflicts with the native env var sync
1 parent b8766e7 commit 21fdb52

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

docs/guides/examples/vercel-sync-env-vars.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,18 @@ description: "This example demonstrates how to sync environment variables from y
66

77
import VercelDocsCards from "/snippets/vercel-docs-cards.mdx";
88

9+
<Warning>
10+
**Deprecated when using the Vercel integration.** If you are using the [Vercel
11+
integration](/vercel-integration), do not use `syncVercelEnvVars` — the integration handles env
12+
var syncing natively and using both together can cause env vars to be incorrectly populated.
13+
14+
If you are **not** using the Vercel integration, `syncVercelEnvVars` is still supported. Continue
15+
with the configuration below.
16+
</Warning>
17+
918
## Build configuration
1019

11-
To sync environment variables, you just need to add our build extension to your `trigger.config.ts` file. This extension will then automatically run every time you deploy your Trigger.dev project.
20+
If you are not using the [Vercel integration](/vercel-integration), you can sync environment variables manually by adding the `syncVercelEnvVars` build extension to your `trigger.config.ts` file. This extension will run automatically every time you deploy your Trigger.dev project.
1221

1322
<Note>
1423
You need to set the `VERCEL_ACCESS_TOKEN` and `VERCEL_PROJECT_ID` environment variables, or pass

docs/vercel-integration.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,12 @@ The following variables are excluded from the Vercel → Trigger.dev sync:
104104

105105
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.
106106

107+
<Warning>
108+
If you are experiencing incorrectly populated environment variables, check that you are not using
109+
the `syncVercelEnvVars` build extension in your `trigger.config.ts`. This extension is deprecated
110+
and conflicts with the Vercel integration's built-in env var syncing. Remove it if present.
111+
</Warning>
112+
107113
### Supabase and Neon database branching
108114

109115
If you use [Supabase Branching](https://supabase.com/docs/guides/deployment/branching) or [Neon Database Branching](https://neon.tech/docs/guides/branching-intro) for preview environments, disable syncing for database env vars on the Environment Variables page and use the [syncSupabaseEnvVars](/config/extensions/syncEnvVars#syncsupabaseenvvars) or [syncNeonEnvVars](/config/extensions/syncEnvVars#syncneonenvvars) build extensions instead. These extensions automatically resolve the correct branch-specific credentials at build time.

0 commit comments

Comments
 (0)