sanity-plugin-dashboard-widget-vercel 1.1.3 → 2.0.0-v3-studio.2

package/CHANGELOG.md

@@ -5,17 +5,25 @@
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [1.1.3](https://github.com/robinpyon/sanity-plugin-dashboard-widget-vercel/compare/v1.1.2...v1.1.3) (2022-09-02)
+## [2.0.0-v3-studio.2](https://github.com/sanity-io/sanity-plugin-dashboard-widget-vercel/compare/v2.0.0-v3-studio.1...v2.0.0-v3-studio.2) (2022-09-15)
 
 ### Bug Fixes
 
-- removed incorrect icon attribute ([23af224](https://github.com/robinpyon/sanity-plugin-dashboard-widget-vercel/commit/23af224737b7405d6c936b04af8b441b47566317))
+- **deps:** sanity 3.0.0-dev-preview.17 ([8d66211](https://github.com/sanity-io/sanity-plugin-dashboard-widget-vercel/commit/8d66211eb8d5b39151f88358a80dc85be1265089))
 
-## [1.1.2](https://github.com/robinpyon/sanity-plugin-dashboard-widget-vercel/compare/v1.1.1...v1.1.2) (2022-09-02)
+## [2.0.0-v3-studio.1](https://github.com/sanity-io/sanity-plugin-dashboard-widget-vercel/compare/v1.1.1...v2.0.0-v3-studio.1) (2022-09-02)
+
+### ⚠ BREAKING CHANGES
+
+- v3 version
+
+### Features
+
+- initial V3 version ([d73b762](https://github.com/sanity-io/sanity-plugin-dashboard-widget-vercel/commit/d73b762ed8b07a696b6c422cfc977d01c28e323b))
 
 ### Bug Fixes
 
-- **deps and ci:** semver workflow ([#7](https://github.com/robinpyon/sanity-plugin-dashboard-widget-vercel/issues/7)) ([05fb9ef](https://github.com/robinpyon/sanity-plugin-dashboard-widget-vercel/commit/05fb9ef1c5bcd4ede17f8b5923a35287a88cfae1))
+- v3 version ([ed8b793](https://github.com/sanity-io/sanity-plugin-dashboard-widget-vercel/commit/ed8b79337dab47316efe8620f5f109edd8381d65))
 
 # Changelog
 

package/README.md

@@ -1,3 +1,9 @@
+> **NOTE**
+>
+> This is the **Sanity Studio v3 version** of sanity-plugin-dashboard-widget-vercel.
+>
+> For the v2 version, please refer to the [v2 version](https://github.com/sanity-io/sanity-plugin-dashboard-widget-vercel/tree/main).
+
 # Vercel Dashboard Widget (for Sanity)
 
 View your recent [Vercel](https://vercel.com/) deployments and manually trigger builds directly from your [Sanity](https://www.sanity.io/) dashboard.
@@ -15,55 +21,55 @@ View your recent [Vercel](https://vercel.com/) deployments and manually trigger
 
 ## Install
 
-In your Sanity project folder:
+```
+npm install --save sanity-plugin-dashboard-widget-vercel@studio-v3
+```
+
+or
 
-```sh
-sanity install dashboard-widget-vercel
+```
+yarn add sanity-plugin-dashboard-widget-vercel@studio-v3
 ```
 
-### Configure your dashboard
+Ensure that you have followed install and usage instructions for [@sanity/dashboard](https://github.com/sanity-io/dashboard).
 
-If you haven't configured a [dashboard](https://www.sanity.io/docs/dashboard) yet:
+## Usage
 
-```sh
-sanity install @sanity/dashboard
-```
+Add it as a widget to @sanity/dashboard plugin in sanity.config.ts (or .js):
 
-In your studio's `sanity.json` append the following to `plugins` and `parts`:
+```js
+import { dashboardTool } from "@sanity/dashboard";
+import { vercelWidget } from "sanity-plugin-dashboard-widget-vercel";
 
-```javascript
-"plugins": [
-  // ...
-  "dashboard-widget-vercel"
-],
-"parts": [
+export default createConfig({
   // ...
-  {
-    "implements": "part:@sanity/dashboard/config",
-    "path": "dashboardConfig.js"
-  }
-]
+  plugins: [
+     dashboardTool({
+             widgets: [
+               vercelWidget(),
+             ],
+         }
+     ),
+  ] 
+})
 ```
 
-In `dashboardConfig.js`, ensure that `widgets` includes the following:
-
-```javascript
-export default {
-  widgets: [
-    // ...
-    {
-      name: 'vercel',
-      layout: {
-        width: 'full', // full width is recommended!
-      },
-    },
-  ],
-}
+### Configure
+
+The widget size can be controlled using layout.width:
+
+```js
+dashboardTool({
+        widgets: [
+          vercelWidget({ layout: { width: "full" /* default and reccomended */ } }),
+        ],
+    }
+)
 ```
 
 ### Add a deployment target
 
-Simply visit your Sanity dashboard and click the '+' icon in the top right to add a new deploment target.
+Simply visit your Sanity dashboard and click the '+' icon in the top right to add a new deployment target.
 
 You'll need to fill in the following:
 
@@ -79,7 +85,8 @@ This can be created in Vercel under **Account > Settings > Tokens**.
 
 #### Vercel Project ID (required)
 
-This can be retrieved via [Vercel's API](https://vercel.com/docs/api#endpoints/projects/get-projects).
+This can be retrieved via [Vercel's API](https://vercel.com/docs/api#endpoints/projects/get-projects),
+or via the web UI on _<project-page> -> Settings -> General -> Scroll down to Project ID_.
 
 #### Vercel Team ID
 
@@ -127,3 +134,10 @@ Please also keep the following in mind when manually deploying:
 ## Contributing
 
 Contributions, issues and feature requests are welcome!
+
+## Release new version
+
+Run ["CI & Release" workflow](https://github.com/sanity-io/sanity-plugin-dashboard-widget-vercel/actions/workflows/main.yml).
+Make sure to select the main (or v3, depending) branch and check "Release new version".
+
+Semantic release will only release on configured branches, so it is safe to run release on any branch.