Vercel Deployment for Sanity

Trigger Vercel Deploy Hooks from your Sanity Studio.
✨ LIVE status updates ✨ multiple deployments ✨ active polling ✨ Vercel Teams support ✨

![vercel-deploy-v2](https://user-images.githubusercontent.com/737188/146429488-5f7e184c-95c3-47e6-87c9-e51a8bee8c40.png)
## Install Run the following command in your studio folder using the Sanity CLI: ```sh npm install sanity-plugin-vercel-deploy ```
## Configure ```ts // `sanity.config.ts` / `sanity.config.js`: import {defineConfig} from 'sanity' import {vercelDeployTool} from 'sanity-plugin-vercel-deploy' export default defineConfig({ // ... plugins: [ // ... vercelDeployTool(), ], }) ```
## Your first Vercel Deployment Once installed, you should see a new "Deploy" tool in your Sanity Studio navbar. To create a new deployment, click the `Add Project` button. Next, you'll be prompted to add the following: **`Title`** > A name for your deployment. This can be whatever you want, to help you organize your deployments. Typically, this should be the environment you are deploying to, like `Production` or `Staging`
**`Vercel Project Name`** > This is the actual Project Name listed in your Vercel account. Navigate to your Project Settings within Vercel to find your Project Name.
**`Vercel Team Slug`** > If your project is part of a Vercel Team you will need to fill out this field. Navigate to your Team from within Vercel, and use the URL slug (ie. vercel.com/`team-666`).
**`Deploy Hook URL`** > This is the Vercel Deploy hook you want to trigger. You can set these up within your Vercel Project, under Settings -> Git and scroll down to the "Deploy Hooks" section. Create your desired hook (ie. "Production Deploy" on `main` branch)
**`Vercel Token`** > This is a token from your Vercel Account (not project). Navigate to your Account Settings, and go to "Tokens". Create a new Token, giving it a recognizable name for what it's being used for, like "Sanity Deploy". A Token will be generated for you to copy **once**. 😎 Once you've created your deployment you can now trigger deploys at anytime!
## Develop & test This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit) with default configuration for build & watch scripts. See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio) on how to run this plugin with hotreload in the studio.
## License ### MIT > [nickdimatteo.com](https://nickdimatteo.com) · > Github [@ndimatteo](https://github.com/ndimatteo) · > Instagram [@ndimatteo](https://instagram.com/ndimatteo)

Vercel Deploy

Install command

v2 install command (deprecated)

Useful links

Contributor

Nick DiMatteo