You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/sips/006-spin-plugins.md
+2-8Lines changed: 2 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -53,9 +53,6 @@ OPTIONS:
53
53
-f, --file Path to local plugin manifest.
54
54
-u, --url Address of remote plugin manifest.
55
55
-v, --version Version of plugin to be installed. Defaults to latest.
56
-
-s, --skip-version-compat-check Instructs Spin to install the plugin even
57
-
if its manifest specifies that it is
58
-
incompatible with the current version of Spin
59
56
```
60
57
61
58
If the manifest is found, Spin will check that the plugin is compatible with the current OS, platform, and version of Spin. If so, before installing the plugin, Spin will prompt the user as to whether to trust the source. For example, the following prompt would be displayed for a plugin named `deploy` with an Apache 2 license and hosted at [`https://github.com/fermyon/spin-plugin-deploy/releases/download/v0.1.0/spin-plugin-deploy-v0.1.0-macos-aarch64.tar.gz`](https://github.com/fermyon/spin-plugin-deploy/releases/download/v0.1.0/spin-plugin-deploy-v0.1.0-macos-aarch64.tar.gz):
@@ -102,12 +99,9 @@ OPTIONS:
102
99
-f, --file Path to local manifest (mutex with `-u`).
103
100
-u, --url Address of remote manifest (mutex with `-f`).
104
101
-d, --downgrade Enables downgrading a plugin to an older specified version.
105
-
-s, --skip-version-compat-check Instructs Spin to install the plugin even
106
-
if its manifest specifies that it is
107
-
incompatible with the current version of Spin
108
102
```
109
103
110
-
The update will fail if the latest or user-specified version of the plugin is not [compatible with the current version of Spin](#plugin-compatibility). This failure can be overridden with `--skip-version-compat-check`.
104
+
The update will fail if the latest or user-specified version of the plugin is not [compatible with the current version of Spin](#plugin-compatibility).
111
105
112
106
### Spin Plugin Manifest
113
107
@@ -209,7 +203,7 @@ The following naming conventions are to be followed for plugins where `$name` i
209
203
Spin plugins must specify compatible versions of Spin in the `spinCompatibility` field of the manifest. The field is expected to be a [comparison operator](https://docs.rs/semver/1.0.13/semver/enum.Op.html) (`=, >, >=, <, <=, ~, ^, *`) along with the compatible version of Spin. The JSON schema validates that the `spinCompatibility` field is a string that matches the following regular expression: `^[><~^*]?[=]?v?(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?(-(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?$`.
210
204
For example, specifying `=0.4` means that the plugin is compatible with versions equivalent to `>=0.4.0, <0.5.0`.
211
205
212
-
Spin will use the [`semver`](https://docs.rs/semver/1.0.13/semver/struct.VersionReq.html) crate that inspired this syntax to verify that the plugin works on the current version of Spin. If it does not, it will fail to install the plugin and log a message explaining the version mismatch. An `--skip-version-compat-check` flag can be added to a plugin installation to ignore this error.
206
+
Spin will use the [`semver`](https://docs.rs/semver/1.0.13/semver/struct.VersionReq.html) crate that inspired this syntax to verify that the plugin works on the current version of Spin. If it does not, it will fail to install the plugin and log a message explaining the version mismatch.
0 commit comments