docs: added section on versioning

This commit is contained in:
Folke Lemaitre 2022-12-18 14:26:24 +01:00
parent 78b284c065
commit c88ad91e31
No known key found for this signature in database
GPG Key ID: 41F8B1FBACAE2040
1 changed files with 19 additions and 0 deletions

View File

@ -116,6 +116,25 @@ Plugins will be lazy-loaded when one of the following is `true`:
- it defines an `init` method
- `config.defaults.lazy == true`
### Versioning
If you want to install a specific revision of a plugin, you can use `commit`,
`tag`, `branch`, `version`.
The `version` property supports [Semver](https://semver.org/) ranges:
- `*`: latest stable version (this excludes pre-release versions)
- `1.2.x`: any version that starts with `1.2`, such as `1.2.0`, `1.2.3`, etc.
- `^1.2.3`: any version that is compatible with `1.2.3`, such as `1.3.0`, `1.4.5`, etc., but not `2.0.0`.
- `~1.2.3`: any version that is compatible with `1.2.3`, such as `1.2.4`, `1.2.5`, but not `1.3.0`.
- `>1.2.3`: any version that is greater than `1.2.3`, such as `1.3.0`, `1.4.5`, etc.
- `>=1.2.3`: any version that is greater than or equal to `1.2.3`, such as `1.2.3`, `1.3.0`, `1.4.5`, etc.
- `<1.2.3`: any version that is less than `1.2.3`, such as `1.1.0`, `1.0.5`, etc.
- `<=1.2.3`: any version that is less than or equal to `1.2.3`, such as `1.2.3`, `1.1.0`, `1.0.5`, etc
> You can set `config.defaults.version = "*"` to install the latest stable
> version of plugins that support Semver.
<!-- spec:start -->
```lua