Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-27 11:02:16 +01:00
Code Issues Projects Releases Wiki Activity

docs: Update SemVer section: clarify what requirements we have

Browse Source
This commit is contained in:
Thomas Heartman 2022-03-08 13:27:19 +01:00
parent 39d01f46ec
commit 2f6b067eb5
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
website/docs/advanced/strategy-constraints.md
View File

@ -134,20 +134,25 @@ String operators differ from the other categories in two different ways:
The SemVer operators are used to compare version numbers such as application versions, dependency versions, etc. The SemVer operators are used to compare version numbers such as application versions, dependency versions, etc.
The SemVer input must follow a few rules:
- The value you enter must at least consist of three version numbers separated by full stops. Example: `1.2.3`
- Optionally, you can also add pre-release version information by adding a hyphen and series of dot separated identifiers after the patch version. Example: `1.2.3-rc.2`
You can enter SemVer values with or without a leading "v": `v1.2.3` and `1.2.3` are both valid. You can enter SemVer values with or without a leading "v": `v1.2.3` and `1.2.3` are both valid.
Importantly, they are also considered equal. Importantly, they are also considered equal.
Versions with pre-release indicators (e.g. `4.8.0-rc.2`) are considered less than versions without (e.g. `4.8.0`) in accordance with [the SemVer specification](https://semver.org/#spec-item-11). Versions with pre-release indicators (e.g. `4.8.0-rc.2`) are considered *less than* versions without (e.g. `4.8.0`) in accordance with [the SemVer specification, item 11](https://semver.org/#spec-item-11).
You can read more about SemVer in [the full SemVer specification](https://semver.org/).
SemVer operators only support single values. SemVer operators only support single values.
| Name | `true` if `<context-field>` is ... | | Name | `true` if `<context-field>` is ... |
|-------------|----------------------------------------------| |-------------|----------------------------------------------|
| `SEMVER_EQ` | **equal** to the provided value | | `SEMVER_EQ` | **equal** to the provided value |
| `SEMVER_GT` | **strictly greater than** the provided value | | `SEMVER_GT` | **strictly greater than** the provided value |
| `SEMVER_LT` | **strictly less than** the provided value | | `SEMVER_LT` | **strictly less than** the provided value |
## Interacting with strategy constraints in the client SDKs {#sdks} ## Interacting with strategy constraints in the client SDKs {#sdks}
:::note :::note