From 967a4b9a245a2e283d876425fa7ab466c25fee37 Mon Sep 17 00:00:00 2001 From: Timo Ley Date: Fri, 16 Sep 2022 16:59:39 +0200 Subject: [PATCH] Remove semver property from manifest An addon should not have two version numbers, either the main version number is semver compatible or nor --- docs/schema/manifest.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/schema/manifest.md b/docs/schema/manifest.md index 8cad994..1865aed 100644 --- a/docs/schema/manifest.md +++ b/docs/schema/manifest.md @@ -5,8 +5,7 @@ "addonscript": {}, "id": "myaddon", "namespace": "com.example", - "version": "1.0", - "semver": "1.0.0", + "version": "1.0.0", "files": [], "relations": [], "flags": {}, @@ -32,7 +31,10 @@ It MUST only contains lowercase alphanumeric characters and hyphens and SHOULD b 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, the `semver` property is implicitly equal to `version` if `semver` was not explicitly set. +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 @@ -44,10 +46,6 @@ This is an [flags object](flags.md) which contains [manifest flags](../concepts/ ## Optional properties -### semver - -This is the version number of this version in semver format. It MUST follow the [semver versioning specifications](https://semver.org/spec/v2.0.0.html). - ### files This is an array of [file objects](file.md) including the files belonging to this addon.