actions-marketplace-validations/Deploy to Vercel Action
Deploy your project to Vercel using GitHub Actions. Supports PR previews and GitHub deployments.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| GITHUB_TOKEN | GitHub Token which will be used to authenticate with the GitHub API. | no | — |
| VERCEL_TOKEN | Vercel Token which will be used with the Vercel CLI. | no | — |
| VERCEL_PROJECT_ID | Id of your Vercel project (can be found in .vercel/project.json). | no | — |
| VERCEL_ORG_ID | Id of your Vercel organisation (can be found in .vercel/project.json). | no | — |
| PRODUCTION | Create a production deployment (default: true, false for PR deployments). | no | — |
| PREBUILT | Deploy a prebuilt Vercel Project (default: false). | no | — |
| GITHUB_DEPLOYMENT | Create a deployment on GitHub (default: true). | no | — |
| CREATE_COMMENT | Create PR comment when deploying (default: true). | no | — |
| DELETE_EXISTING_COMMENT | Delete existing PR comment when redeploying PR (default: true). | no | — |
| ATTACH_COMMIT_METADATA | Attach metadata about the commit to the Vercel deployment (default: true). | no | — |
| DEPLOY_PR_FROM_FORK | Allow PRs which originate from a fork to be deployed (default: false). | no | — |
| PR_LABELS | Labels which will be added to the pull request once deployed. Set it to false to turn off (default: deployed). | no | — |
| ALIAS_DOMAINS | Assign alias domain(s) to the deployment. | no | — |
| PR_PREVIEW_DOMAIN | Assign a custom domain to the PR preview deployment. | no | — |
| VERCEL_SCOPE | Execute commands from a different Vercel team or user. | no | — |
| GITHUB_DEPLOYMENT_ENV | Custom environment for GitHub deployment. | no | — |
| TRIM_COMMIT_MESSAGE | When passing meta data to Vercel deployment, trim the commit message to subject only (default: false). | no | — |
| BUILD_ENV | Provide environment variables to the build step. | no | — |
| WORKING_DIRECTORY | Working directory for the Vercel CLI. | no | — |
| FORCE | Used to skip the build cache. | no | — |
Outputs
| name | description |
|---|---|
| PREVIEW_URL | Main deployment preview URL. |
| DEPLOYMENT_URLS | All assigned deployment URLs. |
| DEPLOYMENT_CREATED | True if a Vercel deployment was created. |
| COMMENT_CREATED | True if a comment was created on the PR or commit. |
| DEPLOYMENT_INSPECTOR_URL | Main deployment inspection url. |
| DEPLOYMENT_UNIQUE_URL | The unique deployment url on Vercel |