w3dev/Deploy for Vercel

Deploy preview and production environments to Vercel

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
vercel_tokenVercel API tokenyes
vercel_org_idVercel Organization/Team IDyes
vercel_project_idVercel Project IDyes
vercel_project_nameVercel Project name (for linking)no""
package_managerPackage manager to use (bun, yarn, npm, pnpm)nobun
package_manager_versionVersion of the package manager to use. If omitted, falls back to the packageManager field in package.json (pnpm) or latest (bun).no""
vercel_cli_versionVercel CLI version to install for reproducible deploysno54.6.1
node_versionNode.js versionno22
working_directoryWorking directory for the buildno.
alias_prefixPrefix for preview alias (e.g., "myapp" creates pr-123--myapp.vercel.app)no""
alias_domainCustom domain for the preview alias (e.g., "preview.example.com" creates pr-123--myapp.preview.example.com instead of pr-123--myapp.vercel.app)no""
prebuild_scriptOptional script to run before `vercel build` (e.g., configure git author)no""
install_commandCustom install command (overrides package_manager default)no""
github_tokenGitHub token for PR commentsno${{ github.token }}
environmentDeployment environment (preview or production)nopreview
predeploy_scriptOptional script to run after `vercel build` but before `vercel deploy --prebuilt`no""
deploy_argsSpace-separated additional arguments to pass to `vercel deploy --prebuilt` (e.g., `--archive=tgz --meta key=value`)no""
teardownRemove preview alias when PR is closednofalse
auto_clean_deploymentAlso delete the deployment itself (not just alias) on teardownnofalse
namedescription
deployment_urlThe Vercel deployment URL
alias_urlThe aliased preview URL
pr_numberThe PR number (if applicable)