From 3fcece26223fb2b728a976b982aa6b94da9fded9 Mon Sep 17 00:00:00 2001 From: Timo Ley Date: Sat, 17 Sep 2022 13:54:34 +0200 Subject: [PATCH] Moving version spec to versioning.md --- docs/concepts/versioning.md | 10 ++++++++-- docs/schema/manifest.md | 7 +------ 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/concepts/versioning.md b/docs/concepts/versioning.md index 07c8414..a03cdc1 100644 --- a/docs/concepts/versioning.md +++ b/docs/concepts/versioning.md @@ -1,7 +1,13 @@ # AddonScript Versioning -Version numbers in AddonScript are based on Maven version numbers. The only difference to the Maven versioning specification is, -that AddonScript version numbers MUST only contain non-space ASCII characters. +## AddonScript Version Numbers + +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 diff --git a/docs/schema/manifest.md b/docs/schema/manifest.md index 1865aed..8155519 100644 --- a/docs/schema/manifest.md +++ b/docs/schema/manifest.md @@ -29,12 +29,7 @@ It MUST only contains lowercase alphanumeric characters and hyphens and SHOULD b ### version -This is the [version number](../concepts/versioning.md) of this version. Versions are compared by -[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. +This is the [AddonScript version number](../concepts/versioning.md#addonscript-version-numbers) of this version. ### namespace