Skip to content

feat(cli): add detailed non-prod build environment check for Convex deploy (#28) #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(cli): add detailed non-prod build environment check for Convex deploy (#28) #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b476b4
feat(cli): add detailed non-prod build environment check for Convex d…
Aman1506-web Nov 2, 2025
91052ef
chore: fix prettier and build issues
Aman1506-web Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions npm-packages/convex/src/cli/deploy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,11 @@ Same format as .env.local or .env files, and overrides them.`,
const ctx = await oneoffContext(cmdOptions);

const deploymentSelection = await getDeploymentSelection(ctx, cmdOptions);

const nonProdReason = isNonProdBuildEnvironment();
if (
cmdOptions.checkBuildEnvironment === "enable" &&
isNonProdBuildEnvironment() &&
nonProdReason &&
deploymentSelection.kind === "existingDeployment" &&
deploymentSelection.deploymentToActOn.source === "deployKey" &&
deploymentSelection.deploymentToActOn.deploymentFields?.deploymentType ===
Expand All @@ -91,9 +93,7 @@ Same format as .env.local or .env files, and overrides them.`,
await ctx.crash({
exitCode: 1,
errorType: "invalid filesystem data",
printedMessage: `Detected a non-production build environment and "${CONVEX_DEPLOY_KEY_ENV_VAR_NAME}" for a production Convex deployment.\n
This is probably unintentional.
`,
printedMessage: `${nonProdReason}\n\nDetected a non-production build environment and "${CONVEX_DEPLOY_KEY_ENV_VAR_NAME}" for a production Convex deployment.\nThis is probably unintentional.`,
});
}

Expand Down
15 changes: 11 additions & 4 deletions npm-packages/convex/src/cli/lib/envvars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,14 +340,21 @@ export function gitBranchFromEnvironment(): string | null {
return null;
}

export function isNonProdBuildEnvironment(): boolean {
// -------------------------------------------------------------
// Improved: Return detailed reason for non-production builds
// -------------------------------------------------------------
export function isNonProdBuildEnvironment(): string | null {
if (process.env.VERCEL) {
// https://vercel.com/docs/projects/environment-variables/system-environment-variables
return process.env.VERCEL_ENV !== "production";
if (process.env.VERCEL_ENV !== "production") {
return `Detected VERCEL because the VERCEL env var is set, but VERCEL_ENV is "${process.env.VERCEL_ENV}" instead of "production".`;
}
}
if (process.env.NETLIFY) {
// https://docs.netlify.com/configure-builds/environment-variables/
return process.env.CONTEXT !== "production";
if (process.env.CONTEXT !== "production") {
return `Detected NETLIFY because the NETLIFY env var is set, but CONTEXT is "${process.env.CONTEXT}" instead of "production".`;
}
}
return false;
return null; // everything looks production-safe
}