Netlify Deployment for Sanity

Trigger Netlify Deploy Hooks from your Sanity V3 Studio.
โœจ LIVE status updates โœจ multiple deployments โœจ active polling โœจ

![netlify-v3](https://raw.githubusercontent.com/jclusso/sanity-plugin-netlify/master/screenshot.png)
## ๐Ÿ”Œ Install ```sh yarn add sanity-plugin-netlify # or npm npm i sanity-plugin-netlify ``` > **Warning**
This is a **Sanity Studio V3** plugin. There is no V2 version.
## โš™๏ธ Configure ```ts // `sanity.config.ts` / `sanity.config.js`: import { defineConfig } from 'sanity' import { netlifyTool } from 'sanity-plugin-netlify' export default defineConfig({ // ... plugins: [ // ... netlifyTool(), ], }) ```
## ๐Ÿš€ Your first Netlify 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: #### `Site Name` A name for your deployment to help you organize your deployments.
_Typically, this should be the name of the site you're deploying_ #### `Site ID` This is the Site ID for your site in your Netlify account.
_You can find this in your Netlify site, under Site Settings โ†’ General โ†’ Site details โ†’ "Site ID"_ #### `Build Hook` This is the Build Hook for your site in your Netlify account.
_You can find this in your Netlify site, under Site Settings โ†’ Build & deploy โ†’ Build hooks_ #### `Branch` _(optional)_ This will override the default branch for your Build Hook.
#### `Access Token` This is your Netlify Personal Access Token.
_You can find this in your Netlify account under User dropdown โ†’ User settings โ†’ Applications โ†’ Personal access 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 > [jarrettlusso.com](https://jarrettlusso.com)  ·  > Github [@jclusso](https://github.com/jclusso)  ·  ### Credits Thanks to [@ndimatteo](https://github.com/ndimatteo) for making [sanity-plugin-vercel-deploy](https://github.com/ndimatteo/sanity-plugin-vercel-deploy) which this was heavily based on.