Docs: Update plugin.json doc as version is not required #992
Conversation
jackw
added
type/docs
|
Hello! 👋 This repository uses Auto for releasing packages using PR labels. ✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs. |
| | `id` | string | **Yes** | | | ||
| | `name` | string | **Yes** | | | ||
| | `type` | string | **Yes** | Possible values are: `app`, `datasource`, `panel`. | | ||
| | `version` | string | **No** | We suggest using [SemVer](https://semver.org/) as your plugin versioning scheme. This property should use a specific, pinned version and not a range. | |
There was a problem hiding this comment.
Maybe add something along the lines "if no version specified, the latest supported version will be used"?
There was a problem hiding this comment.
as your plugin versioning scheme
I'm not sure if this is confusing as the versioning scheme of a plugin you declare a dependency on is not up to you
There was a problem hiding this comment.
I don't think it's up to any plugin developer (original or dependent) as I'm pretty sure all our tooling and some checks within both grafana core and plugin codebases is geared around Semver and if they were to use anything else (such as date of release) things would go wrong somewhere. How about I reword it to:
This property should use a specific, pinned [SemVer](https://semver.org/) version and not a range. If no version is specified, it will resolve to the latest supported version.
and we update the info.version property blurb to read something like:
-Project version of this commit, e.g. `6.7.x`
+[SemVer](https://semver.org/) version of the plugin, e.g. `6.7.1`.
What this PR does / why we need it:
This PR updates the plugin.json doc so the version property of dependencies as it is neither required nor should it use semver ranges. See the accompanying plugin.schema PR here.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: