# actions-vercel

## Guide

- [Guide](/guide/what-is-actions-vercel.md): Learn how nexterias/actions-vercel builds and deploys to Vercel from GitHub Actions while reproducing GitHub integration features.
- [Get Started](/guide/getting-started.md): Set up a GitHub repository, Vercel project, access token, and repository secrets to start deploying with GitHub Actions.
- [Use a Monorepo](/guide/monorepo.md): A guide to using a monorepo with GitHub Actions and actions-vercel.
- [Delete Deployments for Deleted Branches](/guide/cleanup-deployments.md): Automatically delete Vercel Deployments associated with deleted GitHub branches by using a GitHub Actions cleanup workflow.

## Reference

- [token](/references/inputs/required/token.md): Required Vercel access token input. Store this sensitive value securely in GitHub Secrets.
- [project-id](/references/inputs/required/project-id.md): Required Vercel project ID input. Set the ID for the project targeted by this deployment.
- [org-id](/references/inputs/required/org-id.md): Required organization ID input for the Vercel project specified by project-id.
- [build-env](/references/inputs/optional/build-env.md): Configures environment variables for builds run on Vercel, or during vercel build when prebuilt is enabled.
- [cleanup-deployment](/references/inputs/optional/cleanup-deployment.md): Deletes Vercel Deployments associated with deleted GitHub branches when a delete event triggers the workflow; defaults to false.
- [cwd](/references/inputs/optional/cwd.md): Sets the project root directory used by actions-vercel; by default, it uses the value from process.cwd().
- [domain-alias](/references/inputs/optional/domain-alias.md): A deprecated option for configuring a Vercel domain alias, scheduled for removal in v2; configure it in the dashboard instead.
- [env](/references/inputs/optional/env.md): Configures environment variables passed to the running application; they can also be set in the Vercel dashboard.
- [github-deployment-environment](/references/inputs/optional/github-deployment-environment.md): A deprecated option for the GitHub Deployment Environment, scheduled for removal in v2.
- [github-token](/references/inputs/optional/github-token.md): Sets a GitHub Personal Access Token or secrets.GITHUB_TOKEN for deployment, status, and pull request operations.
- [prebuilt](/references/inputs/optional/prebuilt.md): Enables the vercel build and vercel deploy --prebuilt workflow for builds run in GitHub Actions.
- [production](/references/inputs/optional/production.md): Deploys to the production environment when true is set; the default value is false.
- [public](/references/inputs/optional/public.md): Publishes source code at the /_src path when true is set; the default value is false.
- [deployment-url](/references/outputs/deployment-url.md): URL of the deployed application, provided as a string output for later workflow steps.
- [deployment-status](/references/outputs/deployment-status.md): Deployment status after vercel deploy completes, provided as a string output.