sanity-plugin-mux-input 3.0.0 → 3.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -49
- package/dist/{index.mjs → index.cjs} +1172 -1177
- package/dist/index.cjs.map +1 -0
- package/dist/{index.d.mts → index.d.cts} +160 -159
- package/dist/index.d.ts +160 -159
- package/dist/index.js +1172 -1174
- package/dist/index.js.map +1 -1
- package/package.json +24 -44
- package/dist/index.mjs.map +0 -1
package/README.md
CHANGED
|
@@ -179,7 +179,7 @@ export default function MuxVideo({playbackId, title}: {playbackId?: string; titl
|
|
|
179
179
|
}
|
|
180
180
|
```
|
|
181
181
|
|
|
182
|
-
💡
|
|
182
|
+
💡 For an end-to-end frontend integration walkthrough, see the [official Mux + Sanity documentation](https://www.mux.com/docs/integrations/sanity).
|
|
183
183
|
|
|
184
184
|
## Configuring Mux Video uploads
|
|
185
185
|
|
|
@@ -445,55 +445,9 @@ export default defineType({
|
|
|
445
445
|
|
|
446
446
|
## Contributing
|
|
447
447
|
|
|
448
|
-
|
|
448
|
+
This plugin lives in the [`sanity-io/plugins`](https://github.com/sanity-io/plugins) monorepo. Issues and pull requests are welcome — see the monorepo [CONTRIBUTING guide](https://github.com/sanity-io/plugins/blob/main/CONTRIBUTING.md) for development, testing, and release instructions.
|
|
449
449
|
|
|
450
|
-
|
|
451
|
-
1. Create a studio v3 project: `npm create sanity@dev-preview`. Follow the prompts, starting out with the blog template is a good way to go.
|
|
452
|
-
1. `cd` into your project directory, run `npm install && npm start` - your sanity studio should be running on http://localhost:3333.
|
|
453
|
-
1. `cd` into the `plugins` directory of your project.
|
|
454
|
-
1. Fork this repo and clone your fork into the `plugins` directory inside your project `git clone git@github.com:your-fork/sanity-plugin-mux-input.git`.
|
|
455
|
-
1. Open `sanity.json`, go to the `plugins` array and add `mux-input`.
|
|
456
|
-
1. Re-start the sanity studio server with `npm start`.
|
|
457
|
-
1. Edit `schemas/post.js` and add follow the plugin documentation to add a `mux.video` type field.
|
|
458
|
-
1. Your studio should reload, and now when you edit the plugin code it should reload the studio, when you're done creating a branch, put in a PR and a maintainer will review it. Thank you!
|
|
459
|
-
|
|
460
|
-
### Publishing
|
|
461
|
-
|
|
462
|
-
You can run the ["CI and Release" workflow](<[https://github.com/sanity-io/sanity-plugin-mux-input/actions/workflows/ci.yml](https://github.com/sanity-io/sanity-plugin-mux-input/actions/workflows/main.yml)>).
|
|
463
|
-
Make sure to select the main branch and check "Release new version".
|
|
464
|
-
|
|
465
|
-
Semantic release will only release on configured branches, so it is safe to run release on any branch.
|
|
466
|
-
|
|
467
|
-
On the [studio-v2](/tree/studio-v2) branch this will result in:
|
|
468
|
-
|
|
469
|
-
- a new version on the `latest` dist-tag.
|
|
470
|
-
- running `yarn add sanity-plugin-mux-input` or `npm i sanity-plugin-mux-input` will fetch the new version.
|
|
471
|
-
- running `sanity install mux-input` will fetch the new version.
|
|
472
|
-
- studio-v3 users are unaffected.
|
|
473
|
-
|
|
474
|
-
On the [main](/tree/main) branch this will result in:
|
|
475
|
-
|
|
476
|
-
- a new prerelease version on the `studio-v3` dist-tag.
|
|
477
|
-
- running `yarn add sanity-plugin-mux-input@studio-v3` or `npm i sanity-plugin-mux-input@studio-v3` will fetch the new version.
|
|
478
|
-
- running `sanity install mux-input` won't fetch the new version.
|
|
479
|
-
|
|
480
|
-
After Studio v3 turns stable this behavior will change. The v2 version will then be available on the `studio-v2` dist-tag, and `studio-v3` is upgraded to live on `latest`.
|
|
481
|
-
|
|
482
|
-
### Develop & test
|
|
483
|
-
|
|
484
|
-
You can run the example locally by doing the following:
|
|
485
|
-
|
|
486
|
-
1. run `npm install` and `npm dev` on the root of the repo
|
|
487
|
-
2. In the terminal, a command with `yalc` will be shown, that command will allow you to run the version that you have locally directly on the example or on your own app.
|
|
488
|
-
3. run `npm install` and `npm dev` on the `/example` directory where the app with the example exists or in your own app
|
|
489
|
-
4. the studio and app should auto reload with your changes in the plugin package you have locally
|
|
490
|
-
|
|
491
|
-
### Release new version
|
|
492
|
-
|
|
493
|
-
Run ["CI & Release" workflow](https://github.com/sanity-io/sanity-plugin-mux-input/actions/workflows/main.yml).
|
|
494
|
-
Make sure to select the main branch and check "Release new version".
|
|
495
|
-
|
|
496
|
-
Semantic release will only release on configured branches, so it is safe to run release on any branch.
|
|
450
|
+
For frontend playback and end-to-end integration guidance, refer to the [official Mux + Sanity documentation](https://www.mux.com/docs/integrations/sanity).
|
|
497
451
|
|
|
498
452
|
## License
|
|
499
453
|
|