LordMZTE/addonscript-spec
1
0
Fork 0
forked from addonscript/addonscript-spec
Code Issues Pull requests Projects Releases Wiki Activity

Moving version spec to versioning.md

Browse source
This commit is contained in:
Timo Ley 2022-09-17 13:54:34 +02:00
parent 967a4b9a24
commit 3fcece2622
2 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/concepts/versioning.md
View file

@ -1,7 +1,13 @@
# AddonScript Versioning # AddonScript Versioning
Version numbers in AddonScript are based on Maven version numbers. The only difference to the Maven versioning specification is, ## AddonScript Version Numbers
that AddonScript version numbers MUST only contain non-space ASCII characters.
AddonScript version numbers MUST only contain non-whitespace ASCII characters. They SHOULD follow the
[SemVer specifications](https://semver.org/spec/v2.0.0.html). AddonScript version numbers are ordered
according to the [Maven version order specification](#version-order-specification). If an AddonScript
version number is valid SemVer, that version of the addon is SemVer compatible and implies all semantics
according to SemVer. AddonScript implementations MAY provide specific behavior based on the semver semantics,
for example warning the user before updating to a next major version.
## Maven Versioning Specification ## Maven Versioning Specification

7
docs/schema/manifest.md
View file

@ -29,12 +29,7 @@ It MUST only contains lowercase alphanumeric characters and hyphens and SHOULD b
### version ### version
This is the [version number](../concepts/versioning.md) of this version. Versions are compared by This is the [AddonScript version number](../concepts/versioning.md#addonscript-version-numbers) of this version.
[Maven version order rules](../concepts/versioning.md#version-order-specification).
If this version number is valid semver, this version of the addon is semver compatible and implies
all semantics according to the [semver specifications](https://semver.org/spec/v2.0.0.html).
AddonScript implementations MAY provide specific behavior based on the semver semantics, for example
warning the user before updating to a next major version.
### namespace ### namespace