storyblok / field-plugin

Create and deploy Storyblok Field Plugin
https://www.storyblok.com/docs/plugins/field-plugins/introduction
25 stars 3 forks source link

feat(cli): add a disclaimer on how the manifest options will behave when published #338

Closed demetriusfeijoo closed 7 months ago

demetriusfeijoo commented 7 months ago

What?

Improve the printed messages regarding options found in a manifest file and add a disclaimer on what to expect about the behavior of these options when the plugin gets attached to a Field.

Why?

It can be common for users to think that the option values (found in a manifest file) will be shared with a real Field when the plugin gets attached to it, but, it isn't the way it happens.

To avoid sensitive data from getting leaked with other users, all the option values reside accessible only during development time (through the Field Plugin Editor or the Sandbox), and as soon as the field plugin gets attached to a real Field, only the option names are fetched and listed to the user to fulfill.

JIRA: EXT-2170

Creation with no options: manifest-creation-no-options

Creation with options: manifest-creation-with-options

Update with no options: manifest-update-no-options

Update with options: manifest-update-with-options

vercel[bot] commented 7 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
plugin-sandbox ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 18, 2024 4:30pm
demetriusfeijoo commented 7 months ago

I made the requested adjustments, @eunjae-lee 🙌

Let me know what do you think about them.