Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ndimatteo/sanity-plugin-vercel-deploy
Custom plugin to trigger webhooks from your Sanity Studio.
https://github.com/ndimatteo/sanity-plugin-vercel-deploy
nextjs sanity sanity-studio vercel vercel-deployment
Last synced: 9 days ago
JSON representation
Custom plugin to trigger webhooks from your Sanity Studio.
- Host: GitHub
- URL: https://github.com/ndimatteo/sanity-plugin-vercel-deploy
- Owner: ndimatteo
- License: mit
- Created: 2020-07-30T21:59:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T21:39:41.000Z (4 months ago)
- Last Synced: 2024-10-23T08:53:41.869Z (15 days ago)
- Topics: nextjs, sanity, sanity-studio, vercel, vercel-deployment
- Language: TypeScript
- Homepage:
- Size: 1.22 MB
- Stars: 99
- Watchers: 2
- Forks: 20
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Trigger Vercel Deploy Hooks from your Sanity V3 Studio.
✨ LIVE status updates ✨ multiple deployments ✨ active polling ✨ Vercel Teams support ✨
## 🔌 Install
```sh
yarn add sanity-plugin-vercel-deploy
# or npm
npm i sanity-plugin-vercel-deploy
```
> **Warning**
This is a **Sanity Studio V3** plugin. For the V2 version, please refer to the [studio-v2 branch](https://github.com/ndimatteo/sanity-plugin-vercel-deploy/tree/studio-v2).
## ⚙️ 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 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 slugified project name listed in your Vercel account.
_You can find this in your Vercel Project under Settings → General → "Project Name"_
#### `Vercel Team Name` _(optional)_
If your project is part of a Vercel Team you must provide this value.
_You can find this in your Vercel Team, under Settings → General → "Team Name"_
#### `Deploy Hook URL`
This is the Vercel Deploy hook you want to trigger builds with.
_You can find this in your Vercel Project under Settings → Git → "Deploy Hooks"_
#### `Vercel Token`
This is a token from your Vercel Account (not project).
_You can find this from your Vercel Account dropdown under Settings → "Tokens"_
## 🧪 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)