Skip to content

Commit 6e038d4

Browse files
committed
chore: Improve Vercel/Neon syncEnvVars extensions docs
1 parent 05b5396 commit 6e038d4

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

docs/config/extensions/syncEnvVars.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ export default defineConfig({
126126
extensions: [
127127
syncVercelEnvVars({
128128
projectId: "your-vercel-project-id",
129-
vercelAccessToken: "your-vercel-access-token",
129+
vercelAccessToken: "your-vercel-access-token", // optional, we recommend to keep it as env variable
130130
vercelTeamId: "your-vercel-team-id", // optional
131131
}),
132132
],
@@ -190,7 +190,7 @@ export default defineConfig({
190190
extensions: [
191191
syncNeonEnvVars({
192192
projectId: "your-neon-project-id",
193-
neonAccessToken: "your-neon-access-token",
193+
neonAccessToken: "your-neon-access-token", // optional, we recommend to keep it as env variable
194194
branch: "your-branch-name", // optional, defaults to ctx.branch
195195
databaseName: "your-database-name", // optional, defaults to the first database
196196
roleName: "your-role-name", // optional, defaults to the database owner

packages/build/src/extensions/core/neonSyncEnvVars.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,10 @@ function buildNeonEnvVarMappings(options: {
7474

7575
export function syncNeonEnvVars(options?: {
7676
projectId?: string;
77+
/**
78+
* Neon API access token for authentication.
79+
* It's recommended to use the NEON_ACCESS_TOKEN environment variable instead of hardcoding this value.
80+
*/
7781
neonAccessToken?: string;
7882
branch?: string;
7983
databaseName?: string;

packages/build/src/extensions/core/vercelSyncEnvVars.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ type VercelEnvVar = {
1313

1414
export function syncVercelEnvVars(options?: {
1515
projectId?: string;
16+
/**
17+
* Vercel API access token for authentication.
18+
* It's recommended to use the VERCEL_ACCESS_TOKEN environment variable instead of hardcoding this value.
19+
*/
1620
vercelAccessToken?: string;
1721
vercelTeamId?: string;
1822
branch?: string;

0 commit comments

Comments
 (0)