Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 1.3
edited by Helena
on 2025/06/16 15:36
Change comment: There is no comment for this version
To version 2.3
edited by Helena
on 2025/06/16 15:46
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -16,235 +16,136 @@
16 16  
17 17  The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
18 18  
19 -In the following, "versioned" artefacts are understood to be semantically versioned SDMX structural artefacts, and X, Y, Z and EXT are understood as placeholders for the version parts MAJOR, MINOR, PATCH, and EXTENSION, as defined in chapter 4.3.
19 +In the following, "versioned" [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] are understood to be semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], and X, Y, Z and EXT are understood as placeholders for the (% style="color:#e74c3c" %)version(%%) parts MAJOR, MINOR, PATCH, and EXTENSION, as defined in chapter 4.3.
20 20  
21 -The following rules apply to versioned artefacts:
21 +The following rules apply to versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]:
22 22  
23 -* All versioned SDMX artefacts MUST specify a version number.
24 -* The version number of immutable versioned SDMX artefacts MUST take the form X.Y.Z where X, Y, and Z are non-negative integers and MUST NOT contain leading zeroes. X is the MAJOR version, Y is the MINOR version, and Z is the PATCH version. Each element MUST increase numerically. For instance:
23 +* All versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] MUST specify a (% style="color:#e74c3c" %)version(%%) number.
24 +* The (% style="color:#e74c3c" %)version(%%) number of immutable versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] MUST take the form X.Y.Z where X, Y, and Z are non-negative integers and MUST NOT contain leading zeroes. X is the MAJOR (% style="color:#e74c3c" %)version(%%), Y is the MINOR (% style="color:#e74c3c" %)version(%%), and Z is the PATCH (% style="color:#e74c3c" %)version(%%). Each element MUST increase numerically. For instance:
25 25  
26 26  1.9.0 -> 1.10.0 -> 1.11.0.
27 27  
28 -* Once an SDMX artefact with an X.Y.Z version has been shared externally or publicly released, the contents of that version MUST NOT be modified. That artefact version is considered stable. Any modifications MUST be released as a new version.
29 -* MAJOR version zero (0.y.z) is for initial modelling. Anything MAY change at any time. The externally released or public artefact SHOULD NOT be considered stable.
30 -* Version 1.0.0 defines the first stable artefact. The way in which the version number is incremented after this release is dependent on how this externally released or public artefact changes.
31 -* PATCH version Z (x.y.Z | x > 0) MUST be incremented if only backwards compatible property changes are introduced. A property change is defined as an internal change that does not affect the relationship to other artefacts. These are changes in the artefact's or artefact element's names, descriptions and annotations that MUST NOT alter their meaning.
32 -* MINOR version Y (x.Y.z | x > 0) MUST be incremented if a new, backwards compatible element is introduced to a stable artefact. These are additional items in ItemScheme artefacts. It MAY be incremented if substantial new information is introduced within the artefact's properties. It MAY include PATCH level changes. PATCH version MUST be reset to 0 when MINOR version is incremented.
33 -* MAJOR version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to a stable artefact. These often relate to deletions of items in ItemSchemes or to backwards incompatibility introduced due to changes in references to other artefacts. A MAJOR version change MAY also include MINOR and PATCH level changes. PATCH and MINOR version MUST be reset to 0 when MAJOR version is incremented.
34 -* A mutable version, e.g. used for externally released or public drafts or as prerelease, MUST be denoted by appending an EXTENSION that consists of a hyphen and a series of dot separated identifiers immediately following the PATCH version (x.y.z-EXT). Identifiers MUST comprise only ASCII alphanumerics and hyphen [0-9A-Za-z-]. Identifiers MUST NOT be empty. Numeric identifiers MUST NOT include leading zeroes. However, to foster harmonisation and general comprehension it is generally recommended to use the standard EXTENSION "**-draft**". Extended versions have a lower precedence than the associated stable version. An extended version indicates that the version is unstable and it might not satisfy the intended compatibility requirements as denoted by its associated stable version. When making changes to an SDMX artefact with an extended version number then one is not required to increment the version if those changes are kept within the allowed scope of the version increment from the previous version (if that existed), otherwise also here the before mentioned version increment rules for X.Y.Z apply. Concretely, a version X.0.0-EXT will allow for any changes, a version X.Y.0-EXT will allow only for MINOR changes and a version X.Y.Z-EXT will allow only for any PATCH changes, as defined above. EXTENSION examples:
28 +* Once an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] with an X.Y.Z (% style="color:#e74c3c" %)version(%%) has been shared externally or publicly released, the contents of that (% style="color:#e74c3c" %)version(%%) MUST NOT be modified. That [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)version(%%) is considered stable. Any modifications MUST be released as a new (% style="color:#e74c3c" %)version(%%).
29 +* MAJOR (% style="color:#e74c3c" %)version(%%) zero (0.y.z) is for initial modelling. Anything MAY change at any time. The externally released or public [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] SHOULD NOT be considered stable.
30 +* (% style="color:#e74c3c" %)Version(%%) 1.0.0 defines the first stable [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. The way in which the (% style="color:#e74c3c" %)version(%%) number is incremented after this release is dependent on how this externally released or public [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] changes.
31 +* PATCH (% style="color:#e74c3c" %)version(%%) Z (x.y.Z | x > 0) MUST be incremented if only backwards compatible property changes are introduced. A property change is defined as an internal change that does not affect the relationship to other [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. These are changes in the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]'s or [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] element's names, descriptions and [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]] that MUST NOT alter their meaning.
32 +* MINOR (% style="color:#e74c3c" %)version(%%) Y (x.Y.z | x > 0) MUST be incremented if a new, backwards compatible element is introduced to a stable [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. These are additional items in ItemScheme [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. It MAY be incremented if substantial new information is introduced within the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]'s properties. It MAY include PATCH (% style="color:#e74c3c" %)level(%%) changes. PATCH (% style="color:#e74c3c" %)version(%%) MUST be reset to 0 when MINOR (% style="color:#e74c3c" %)version(%%) is incremented.
33 +* MAJOR (% style="color:#e74c3c" %)version(%%) X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to a stable [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. These often relate to deletions of items in ItemSchemes or to backwards incompatibility introduced due to changes in references to other [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. A MAJOR (% style="color:#e74c3c" %)version(%%) change MAY also include MINOR and PATCH (% style="color:#e74c3c" %)level(%%) changes. PATCH and MINOR (% style="color:#e74c3c" %)version(%%) MUST be reset to 0 when MAJOR (% style="color:#e74c3c" %)version(%%) is incremented.
34 +* A mutable (% style="color:#e74c3c" %)version(%%), e.g. used for externally released or public drafts or as prerelease, MUST be denoted by appending an EXTENSION that consists of a hyphen and a series of dot separated identifiers immediately following the PATCH (% style="color:#e74c3c" %)version(%%) (x.y.z-EXT). Identifiers MUST comprise only ASCII alphanumerics and hyphen [0-9A-Za-z-]. Identifiers MUST NOT be empty. Numeric identifiers MUST NOT include leading zeroes. However, to foster harmonisation and general comprehension it is generally recommended to use the standard EXTENSION "**-draft**". Extended (% style="color:#e74c3c" %)versions(%%) have a lower precedence than the associated stable (% style="color:#e74c3c" %)version(%%). An extended (% style="color:#e74c3c" %)version(%%) indicates that the (% style="color:#e74c3c" %)version(%%) is unstable and it might not satisfy the intended compatibility requirements as denoted by its associated stable (% style="color:#e74c3c" %)version(%%). When making changes to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] with an extended (% style="color:#e74c3c" %)version(%%) number then one is not required to increment the (% style="color:#e74c3c" %)version(%%) if those changes are kept within the allowed scope of the (% style="color:#e74c3c" %)version(%%) increment from the previous (% style="color:#e74c3c" %)version(%%) (if that existed), otherwise also here the before mentioned (% style="color:#e74c3c" %)version(%%) increment rules for X.Y.Z apply. Concretely, a (% style="color:#e74c3c" %)version(%%) X.0.0-EXT will allow for any changes, a (% style="color:#e74c3c" %)version(%%) X.Y.0-EXT will allow only for MINOR changes and a (% style="color:#e74c3c" %)version(%%) X.Y.Z-EXT will allow only for any PATCH changes, as defined above. EXTENSION examples:
35 35  
36 36  1.0.0-draft, 1.0.0-draft.1, 1.0.0-0.3.7, 1.0.0-x.7.z.92.
37 37  
38 -* Precedence refers to how versions are compared to each other when ordered. Precedence MUST be calculated by separating the version into MAJOR, MINOR, PATCH and EXTENSION identifiers in that order. Precedence is determined by the first difference when comparing each of these identifiers from left to right as follows: MAJOR, MINOR, and PATCH versions are always compared numerically. Example: 1.0.0 < 2.0.0 < 2.1.0 < 2.1.1. When MAJOR, MINOR, and PATCH are equal, an extended version has lower precedence than a stable version. Example: 1.0.0-draft < 1.0.0. Precedence for two extended versions with the same MAJOR, MINOR, and PATCH version MUST be determined by comparing each dot separated identifier from left to right until a difference is found as follows: identifiers consisting of only digits are compared numerically and identifiers with letters or hyphens are compared lexically in ASCII sort order. Numeric identifiers always have lower precedence than non-numeric identifiers. A larger set of EXTENSION fields has a higher precedence than a smaller set, if all of the preceding identifiers are equal. Example: 1.0.0-draft < 1.0.0-draft.1 < 1.0.0-draft.prerelease < 1.0.0-prerelease < 1.0.0-prerelease.2 <
38 +* Precedence refers to how (% style="color:#e74c3c" %)versions(%%) are compared to each other when ordered. Precedence MUST be calculated by separating the (% style="color:#e74c3c" %)version(%%) into MAJOR, MINOR, PATCH and EXTENSION identifiers in that order. Precedence is determined by the first difference when comparing each of these identifiers from left to right as follows: MAJOR, MINOR, and PATCH (% style="color:#e74c3c" %)versions(%%) are always compared numerically. Example: 1.0.0 < 2.0.0 < 2.1.0 < 2.1.1. When MAJOR, MINOR, and PATCH are equal, an extended (% style="color:#e74c3c" %)version(%%) has lower precedence than a stable (% style="color:#e74c3c" %)version(%%). Example: 1.0.0-draft < 1.0.0. Precedence for two extended (% style="color:#e74c3c" %)versions(%%) with the same MAJOR, MINOR, and PATCH (% style="color:#e74c3c" %)version(%%) MUST be determined by comparing each dot separated identifier from left to right until a difference is found as follows: identifiers consisting of only digits are compared numerically and identifiers with letters or hyphens are compared lexically in ASCII sort order. Numeric identifiers always have lower precedence than non-numeric identifiers. A larger set of EXTENSION fields has a higher precedence than a smaller set, if all of the preceding identifiers are equal. Example: 1.0.0-draft < 1.0.0-draft.1 < 1.0.0-draft.prerelease < 1.0.0-prerelease < 1.0.0-prerelease.2 <
39 39  
40 40  1.0.0-prerelease.11 < 1.0.0-rc.1 < 1.0.0.
41 41  
42 -* The reasons for version changes MAY be documented in brief form in an artefact's annotation of type "CHANGELOG".
43 -*1. Backus–Naur Form Grammar for Valid SDMX 3.0(.0) Semantic Versions
42 +* The reasons for (% style="color:#e74c3c" %)version(%%) changes MAY be documented in brief form in an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]'s [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]] of type "CHANGELOG".
44 44  
45 -|(((
46 -**<valid semver> ::= <version core>**
44 +== 14.3 Backus–Naur Form Grammar for Valid SDMX 3.0(.0) Semantic Versions ==
47 47  
48 -**~ | <version core> "-" <extension>**
46 +[[image:1750077413040-228.png]]
49 49  
50 -**<version core> ::= <major> "." <minor> "." <patch>**
48 +[[image:1750077431756-519.png]]
51 51  
52 -**~ **
50 +== 14.4 Dependency Management in SDMX 3.0(.0): ==
53 53  
54 -**<major> ::= <numeric identifier>**
52 +MAJOR, MINOR or PATCH (% style="color:#e74c3c" %)version(%%) parts in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] references CAN be wildcarded using "+" as extension:
55 55  
56 -**~ **
54 +* X+.Y.Z means the currently latest available (% style="color:#e74c3c" %)version(%%) >= X.Y.Z
55 +** Example: "2+.3.1" means the currently latest available (% style="color:#e74c3c" %)version(%%) >="2.3.1" (even if not backwards compatible)
56 +** Typical use case: references in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Categorisations
57 +* X.Y+.Z means the currently latest available backwards compatible (% style="color:#e74c3c" %)version(%%) >=X.Y.Z
58 +** Example: "2.3+.1" means the currently latest available (% style="color:#e74c3c" %)version(%%) >= "2.3.1" and < "3.0.0" (all backwards compatible (% style="color:#e74c3c" %)versions(%%) >="2.3.1")
59 +** Typical use case: references in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] DSD
57 57  
58 -**<minor> ::= <numeric identifier>**
61 +* X.Y.Z+ means the currently latest available forwards and backwards compatible (% style="color:#e74c3c" %)version(%%) >= X.Y.Z o Example: "2.3.1+" means the currently latest available (% style="color:#e74c3c" %)version(%%) >= "2.3.1" and < "2.4.0" (all forwards and backwards compatible (% style="color:#e74c3c" %)versions(%%) >= "2.3.1")
62 +* Non-versioned and 2-digit (% style="color:#e74c3c" %)version(%%) [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] CAN reference any other non-versioned or versioned (whether SemVer or not) [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].
63 +* Semantically versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] MUST only reference other semantically versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].
64 +* Wildcarded references in a stable [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] implicitly target only future stable (% style="color:#e74c3c" %)versions(%%) of the referenced [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] within the defined wildcard scope.
65 +** Example: The reference to "AGENCY_ID:CODELIST_ID(2.3+.1)" in an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] "AGENCY_ID:DSD_ID(2.2.1)" resolves to [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] "AGENCY_ID:CODELIST_ID(2.4.3)" if that was currently the latest available stable (% style="color:#e74c3c" %)version(%%).
66 +* Wildcarded references in a (% style="color:#e74c3c" %)version(%%)-extended [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] implicitly target future stable and (% style="color:#e74c3c" %)version(%%)-extended (% style="color:#e74c3c" %)versions(%%) of the referenced [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] within the defined wildcard scope.
67 +** Example: The reference to "AGENCY_ID:CODELIST_ID(2.3+.1)" in an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] "AGENCY_ID:DSD_ID(2.2.1-draft)" resolves to [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] "AGENCY_ID:CODELIST_ID(2.5.0-draft)" if that was currently the latest available (% style="color:#e74c3c" %)version(%%).
68 +* References to specific (% style="color:#e74c3c" %)version(%%)-extended [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] MAY be used, but those cannot be combined with a wildcard.
69 +** Example: The reference to "AGENCY_ID:CODELIST_ID(2.5.0draft)" in an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] "AGENCY_ID:DSD_ID(2.2.1)" resolves to [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] "AGENCY_ID:CODELIST_ID(2.5.0-draft)", which might be subject to continued backwards compatible changes.
59 59  
60 -**~ **
71 +Because both, wildcarded references and references to (% style="color:#e74c3c" %)version(%%)-extended [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], allow for changes in the referenced [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], care needs to be taken when choosing the appropriate references in order to achieve the required limitation in the allowed scope of changes.
61 61  
62 -**<patch> ::= <numeric identifier>**
73 +For references to non-dependent [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], MAJOR, MINOR or PATCH (% style="color:#e74c3c" %)version(%%) parts in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] references CAN alternatively be wildcarded using "*" as replacement:
63 63  
64 -**~ **
75 +~* means all available (% style="color:#e74c3c" %)versions
65 65  
66 -**<extension> ::= <dot-separated extension identifiers>**
77 +== 14.5 Upgrade and conversions of artefacts defined with previous SDMX standard versions to Semantic Versioning ==
67 67  
68 -**~ **
79 +Because [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standardises the interactions between statistical systems, which cannot all be upgraded at the same time, the new versioning rules cannot be applied to existing [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] in EDIFACT, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 1.0, 2.0 or 2.1. SemVer can only be applied to structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that are newly modelled with the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Information Model. Migrating to SemVer means migrating to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Information Model, to its new API (% style="color:#e74c3c" %)version(%%) and new (% style="color:#e74c3c" %)versions(%%) of its exchange message formats.
69 69  
70 -**<dot-separated extension identifiers> ::= <extension identifier>**
81 +To migrate [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] created previously to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0.0:
71 71  
72 -**~ | <extension identifier> "." <dotseparated extension identifiers>**
83 +If the [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] do not need versioning, then the new [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] based on the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Information Model SHOULD remain as-is, e.g., a previous [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] with the non-final (% style="color:#e74c3c" %)version(%%) 1.0 and that doesn't need versioning becomes non-versioned, i.e., keeps (% style="color:#e74c3c" %)version(%%) 1.0. This will be the case for all AgencyScheme [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].
73 73  
74 -**~ **
85 +If [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] versioning is required and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0.0 Semantic Versioning is available within the tools and processes used, then it is recommended to switch to Semantic Versioning with the following steps:
75 75  
76 -**<extension identifier> ::= <alphanumeric identifier>**
87 +~1. Complement the missing (% style="color:#e74c3c" %)version(%%) parts with 0s to make the (% style="color:#e74c3c" %)version(%%) number SemVer-compliant using the MAJOR.MINOR.PATCH-EXTENSION syntax:
77 77  
78 -**~ | <numeric identifier>**
89 +Example: (% style="color:#e74c3c" %)Version(%%) 2 becomes (% style="color:#e74c3c" %)version(%%) 2.0.0 and (% style="color:#e74c3c" %)version(%%) 3.1 becomes (% style="color:#e74c3c" %)version(%%) 3.1.0.
79 79  
80 -**~ **
91 +2. Replace the "isFinal=false" property by the (% style="color:#e74c3c" %)version(%%) extensions "-draft" (or alternatively "-unstable" or "-nonfinal" depending on the use case).
81 81  
82 -**<alphanumeric identifier> ::= <non-digit>**
93 +Example: (% style="color:#e74c3c" %)Version(%%) 1.3 with isFinal=true becomes (% style="color:#e74c3c" %)version(%%) 1.3.0 and (% style="color:#e74c3c" %)version(%%) 1.3 with isFinal=false becomes (% style="color:#e74c3c" %)version(%%) 1.3.0-draft.
83 83  
84 -**~ | <non-digit> <identifier characters>**
95 +If [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] versioning is required but semantic versioning cannot be applied, then (% style="color:#e74c3c" %)version(%%) strings used in previous (% style="color:#e74c3c" %)versions(%%) of the Standard (e.g., (% style="color:#e74c3c" %)version(%%)=1.2) may continue to be used.
85 85  
86 -**~ | <identifier characters> <non-digit>**
97 +Note: Like for other not fully backwards compatible [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 features, also some cases of semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] cannot be converted back to earlier [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#e74c3c" %)versions(%%). This is the case when one or more extensions have been created in parallel to the corresponding stable (% style="color:#e74c3c" %)version(%%). In this case, only the stable (% style="color:#e74c3c" %)version(%%) SHOULD be converted to a final (% style="color:#e74c3c" %)version(%%) (e.g., 3.2.1 becomes 3.2.1 final, and 3.2.1-draft cannot be converted back).
87 87  
88 -**~ | <identifier characters> <non-digit> <identifier characters>**
99 +== 14.6 FAQ for Semantic Versioning ==
89 89  
90 -**~ **
91 -
92 -**<numeric identifier> ::= "0"**
93 -
94 -**~ | <positive digit>**
95 -
96 -**~ | <positive digit> <digits>**
97 -
98 -**~ **
99 -
100 -**<identifier characters> ::= <identifier character>**
101 -
102 -**~ | <identifier character> <identifier characters>**
103 -)))
104 -
105 -**<identifier character> ::= <digit>**
106 -
107 -**~ | <non-digit>**
108 -
109 -**~ **
110 -
111 -**<non-digit> ::= <letter>**
112 -
113 -**~ | "-"**
114 -
115 -**~ **
116 -
117 -**<digits> ::= <digit>**
118 -
119 -**~ | <digit> <digits>**
120 -
121 -**~ **
122 -
123 -**<digit> ::= "0"**
124 -
125 -**~ | <positive digit>**
126 -
127 -**~ **
128 -
129 -**<positive digit> ::= "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"**
130 -
131 -**<letter> ::= "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J"**
132 -
133 -**~ | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T"**
134 -
135 -**~ | "U" | "V" | "W" | "X" | "Y" | "Z" | "a" | "b" | "c" | "d"**
136 -
137 -**~ | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n"**
138 -
139 -**~ | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x"**
140 -
141 -**~ | "y" | "z"**
142 -
143 -1.
144 -11. Dependency Management in SDMX 3.0(.0):
145 -
146 -MAJOR, MINOR or PATCH version parts in SDMX 3.0 artefact references CAN be wildcarded using "+" as extension:
147 -
148 -* X+.Y.Z means the currently latest available version >= X.Y.Z o Example: "2+.3.1" means the currently latest available version >=
149 -
150 -"2.3.1" (even if not backwards compatible) o Typical use case: references in SDMX Categorisations
151 -
152 -* X.Y+.Z means the currently latest available backwards compatible version >=
153 -
154 -X.Y.Z o Example: "2.3+.1" means the currently latest available version >= "2.3.1" and < "3.0.0" (all backwards compatible versions >=
155 -
156 -"2.3.1") o Typical use case: references in SDMX DSD
157 -
158 -* X.Y.Z+ means the currently latest available forwards and backwards compatible version >= X.Y.Z o Example: "2.3.1+" means the currently latest available version >= "2.3.1" and < "2.4.0" (all forwards and backwards compatible versions >= "2.3.1")
159 -* Non-versioned and 2-digit version SDMX structural artefacts CAN reference any other non-versioned or versioned (whether SemVer or not) SDMX structural artefacts.
160 -* Semantically versioned artefacts MUST only reference other semantically versioned artefacts.
161 -* Wildcarded references in a stable artefact implicitly target only future stable versions of the referenced artefacts within the defined wildcard scope.
162 -** Example: The reference to "AGENCY_ID:CODELIST_ID(2.3+.1)" in an artefact "AGENCY_ID:DSD_ID(2.2.1)" resolves to artefact "AGENCY_ID:CODELIST_ID(2.4.3)" if that was currently the latest available stable version.
163 -* Wildcarded references in a version-extended artefact implicitly target future stable and version-extended versions of the referenced artefacts within the defined wildcard scope.
164 -** Example: The reference to "AGENCY_ID:CODELIST_ID(2.3+.1)" in an artefact "AGENCY_ID:DSD_ID(2.2.1-draft)" resolves to artefact "AGENCY_ID:CODELIST_ID(2.5.0-draft)" if that was currently the latest available version.
165 -* References to specific version-extended artefacts MAY be used, but those cannot be combined with a wildcard.
166 -** Example: The reference to "AGENCY_ID:CODELIST_ID(2.5.0draft)" in an artefact "AGENCY_ID:DSD_ID(2.2.1)" resolves to artefact "AGENCY_ID:CODELIST_ID(2.5.0-draft)", which might be subject to continued backwards compatible changes.
167 -
168 -Because both, wildcarded references and references to version-extended artefacts, allow for changes in the referenced artefacts, care needs to be taken when choosing the appropriate references in order to achieve the required limitation in the allowed scope of changes.
169 -
170 -For references to non-dependent artefacts, MAJOR, MINOR or PATCH version parts in SDMX 3.0 artefact references CAN alternatively be wildcarded using "*" as replacement:
171 -
172 -~* means all available versions
173 -
174 -1.
175 -11. Upgrade and conversions of artefacts defined with previous SDMX standard versions to Semantic Versioning
176 -
177 -Because SDMX standardises the interactions between statistical systems, which cannot all be upgraded at the same time, the new versioning rules cannot be applied to existing artefacts in EDIFACT, SDMX 1.0, 2.0 or 2.1. SemVer can only be applied to structural artefacts that are newly modelled with the SDMX 3.0 Information Model. Migrating to SemVer means migrating to the SDMX 3.0 Information Model, to its new API version and new versions of its exchange message formats.
178 -
179 -To migrate SDMX structural artefacts created previously to SDMX 3.0.0:
180 -
181 -If the artefacts do not need versioning, then the new artefacts based on the SDMX 3.0 Information Model SHOULD remain as-is, e.g., a previous artefact with the non-final version 1.0 and that doesn't need versioning becomes non-versioned, i.e., keeps version 1.0. This will be the case for all AgencyScheme artefacts.
182 -
183 -If artefact versioning is required and SDMX 3.0.0 Semantic Versioning is available within the tools and processes used, then it is recommended to switch to Semantic Versioning with the following steps:
184 -
185 -1. Complement the missing version parts with 0s to make the version number SemVer-compliant using the MAJOR.MINOR.PATCH-EXTENSION syntax:
186 -
187 -Example: Version 2 becomes version 2.0.0 and version 3.1 becomes version 3.1.0.
188 -
189 -1. Replace the "isFinal=false" property by the version extensions "-draft" (or alternatively "-unstable" or "-nonfinal" depending on the use case).
190 -
191 -Example: Version 1.3 with isFinal=true becomes version 1.3.0 and version 1.3 with isFinal=false becomes version 1.3.0-draft.
192 -
193 -If artefact versioning is required but semantic versioning cannot be applied, then version strings used in previous versions of the Standard (e.g., version=1.2) may continue to be used.
194 -
195 -Note: Like for other not fully backwards compatible SDMX 3.0 features, also some cases of semantically versioned SDMX 3.0 artefacts cannot be converted back to earlier SDMX versions. This is the case when one or more extensions have been created in parallel to the corresponding stable version. In this case, only the stable version SHOULD be converted to a final version (e.g., 3.2.1 becomes 3.2.1 final, and 3.2.1-draft cannot be converted back).
196 -
197 -1.
198 -11. FAQ for Semantic Versioning
199 -
200 200  **My organisation is new to SDMX and starts to implement 3.0 or starts to implement a new process fully based on SDMX 3.0. Which versioning scheme should be used?**
201 201  
202 -If all counterparts involved in the process and all tools used for its implementation are SDMX 3.0-ready, then it is recommended to:
103 +If all counterparts involved in the process and all tools used for its implementation are [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0-ready, then it is recommended to:
203 203  
204 204  * in general, use semantic versioning;
205 -* exceptionally, do not use versioning for artefacts that do not require it, e.g. artefacts that never change, that are only used internally or for which communication on changes with external parties or systems is not required.
106 +* exceptionally, do not use versioning for [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that do not require it, e.g. [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that never change, that are only used internally or for which communication on changes with external parties or systems is not required.
206 206  
207 207  **How should I deal with revisions in the 0.y.z initial modelling phase?**
208 208  
209 -The simplest thing to do is start your initial modelling release at 0.1.0 and then increment the minor version for each subsequent release.
110 +The simplest thing to do is start your initial modelling release at 0.1.0 and then increment the minor (% style="color:#e74c3c" %)version(%%) for each subsequent release.
210 210  
211 211  **How do I know when to release 1.0.0?**
212 212  
213 -If your data model is being used in production, it should probably already be 1.0.0. If you have a stable artefact on which users have come to depend, you should be 1.0.0. If you're worrying a lot about backwards compatibility, you should probably already be 1.0.0.
114 +If your data model is being used in production, it should probably already be 1.0.0. If you have a stable [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] on which users have come to depend, you should be 1.0.0. If you're worrying a lot about backwards compatibility, you should probably already be 1.0.0.
214 214  
215 215  **Doesn't this discourage rapid modelling and fast iteration?**
216 216  
217 -Major version zero is all about rapid modelling. If you're changing the artefact every day you should either still be in version 0.y.z or on the next (minor or) major version for a separate modelling.
118 +Major (% style="color:#e74c3c" %)version(%%) zero is all about rapid modelling. If you're changing the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] every day you should either still be in (% style="color:#e74c3c" %)version(%%) 0.y.z or on the next (minor or) major (% style="color:#e74c3c" %)version(%%) for a separate modelling.
218 218  
219 -**If even the tiniest backwards incompatible changes to the public artefact require a major version bump, won't I end up at version 42.0.0 very rapidly?**
120 +**If even the tiniest backwards incompatible changes to the public [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] require a major (% style="color:#e74c3c" %)version(%%) bump, won't I end up at (% style="color:#e74c3c" %)version(%%) 42.0.0 very rapidly?**
220 220  
221 -This is a question of responsible modelling and foresight. Incompatible changes should not be introduced lightly to a data model that has a lot of dependencies. The cost that must be incurred to upgrade can be significant. Having to bump major versions to release incompatible changes means you will think through the impact of your changes, and evaluate the cost/benefit ratio involved.
122 +This is a question of responsible modelling and foresight. Incompatible changes should not be introduced lightly to a data model that has a lot of dependencies. The cost that must be incurred to upgrade can be significant. Having to bump major (% style="color:#e74c3c" %)versions(%%) to release incompatible changes means you will think through the impact of your changes, and evaluate the cost/benefit ratio involved.
222 222  
223 223  **Documenting the version changes in an artefact's annotation of type "CHANGELOG" is too much work!**
224 224  
225 -It is your responsibility as a professional modeller to properly document the artefacts that are intended for use by others. Managing data model complexity is a hugely important part of keeping a project efficient, and that's hard to do if nobody knows how to use your data model, or what artefacts are safe to reuse. In the long run, SDMX 3.0 Semantic Versioning can keep everyone and everything running smoothly.
126 +It is your responsibility as a professional modeller to properly document the [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that are intended for use by others. Managing data model complexity is a hugely important part of keeping a project efficient, and that's hard to do if nobody knows how to use your data model, or what [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] are safe to reuse. In the long run, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Semantic Versioning can keep everyone and everything running smoothly.
226 226  
227 -However, refrain from overdoing. Nobody can and will read too long lists of changes. Thus, keep it to the absolute essence, and mainly use it for short announcements. You can even skip the changelog if the change is impact-less. For all complete reports, a new API feature could be more useful to automatically generate a log of differences between two versions.
128 +However, refrain from overdoing. Nobody can and will read too long lists of changes. Thus, keep it to the absolute essence, and mainly use it for short announcements. You can even skip the changelog if the change is impact-less. For all complete reports, a new API feature could be more useful to automatically generate a log of differences between two (% style="color:#e74c3c" %)versions(%%).
228 228  
229 229  **What do I do if I accidentally release a backwards incompatible change as a minor version?**
230 230  
231 -As soon as you realise that you've broken the SDMX 3.0 Semantic Versioning specification, fix the problem and release a new minor version that corrects the problem and restores backwards compatibility. Even under this circumstance, it is unacceptable to modify versioned releases. If it's appropriate, document the offending version and inform your users of the problem so that they are aware of the offending version.
132 +As soon as you realise that you've broken the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Semantic Versioning specification, fix the problem and release a new minor (% style="color:#e74c3c" %)version(%%) that corrects the problem and restores backwards compatibility. Even under this circumstance, it is unacceptable to modify versioned releases. If it's appropriate, document the offending (% style="color:#e74c3c" %)version(%%) and inform your users of the problem so that they are aware of the offending (% style="color:#e74c3c" %)version(%%).
232 232  
233 233  **What if I inadvertently alter the public artefact in a way that is not compliant with the version number change (i.e. the modification incorrectly introduces a major breaking change in a patch release)?**
234 234  
235 -Use your best judgement. If you have a huge audience that will be drastically impacted by changing the behaviour back to what the public artefact intended, then it may be best to perform a major version release, even though the property change could strictly be considered a patch release. Remember, SDMX 3.0.0 Semantic Versioning is all about conveying meaning by how the version number changes. If these changes are important to your users, use the version number to inform them.
136 +Use your best judgement. If you have a huge audience that will be drastically impacted by changing the behaviour back to what the public [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] intended, then it may be best to perform a major (% style="color:#e74c3c" %)version(%%) release, even though the property change could strictly be considered a patch release. Remember, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0.0 Semantic Versioning is all about conveying meaning by how the (% style="color:#e74c3c" %)version(%%) number changes. If these changes are important to your users, use the (% style="color:#e74c3c" %)version(%%) number to inform them.
236 236  
237 237  **How should I handle deprecating elements?**
238 238  
239 -Deprecating existing elements is a normal part of data modelling and is often required to make forward progress or follow history (changing classifications, evolving reference areas). When you deprecate part of your stable artefact, you should issue a new minor version with the deprecation in place (e.g. add the new country code but still keep the old country code) and with a "CHANGELOG" annotation announcing the deprecation (e.g. the intention to remove the old country code in a future version) . Before you completely remove the functionality in a new major release there should be at least one minor release that contains the deprecation so that users can smoothly transition to the new artefact.
140 +Deprecating existing elements is a normal part of data modelling and is often required to make forward progress or follow history (changing classifications, evolving [[reference areas>>doc:sdmx:Glossary.Reference area.WebHome]]). When you deprecate part of your stable [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], you should issue a new minor (% style="color:#e74c3c" %)version(%%) with the deprecation in place (e.g. add the new country [[code>>doc:sdmx:Glossary.Code.WebHome]] but still keep the old country [[code>>doc:sdmx:Glossary.Code.WebHome]]) and with a "CHANGELOG" [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]] announcing the deprecation (e.g. the intention to remove the old country [[code>>doc:sdmx:Glossary.Code.WebHome]] in a future (% style="color:#e74c3c" %)version(%%)) . Before you completely remove the functionality in a new major release there should be at least one minor release that contains the deprecation so that users can smoothly transition to the new [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]].
240 240  
241 241  **Does SDMX 3.0.0 Semantic Versioning have a size limit on the version string?**
242 242  
243 -No, but use good judgement. A 255 character version string is probably overkill, for example. In addition, specific SDMX implementations may impose their own limits on the size of the string. Remember, it is generally recommended to use the standard extension "-draft".
144 +No, but use good judgement. A 255 character (% style="color:#e74c3c" %)version(%%) string is probably overkill, for example. In addition, specific [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] implementations may impose their own limits on the size of the string. Remember, it is generally recommended to use the standard extension "-draft".
244 244  
245 245  **Is "v1.2.3" a semantic version?**
246 246  
247 -No, "v1.2.3" is not a semantic version. The semantic version is "1.2.3".
148 +No, "v1.2.3" is not a semantic (% style="color:#e74c3c" %)version(%%). The semantic (% style="color:#e74c3c" %)version(%%) is "1.2.3".
248 248  
249 249  **Is there a suggested regular expression (RegEx) to check an SDMX 3.0.0 Semantic Versioning string?**
250 250  
... ... @@ -252,46 +252,38 @@
252 252  
253 253  One with named groups for those systems that support them (PCRE [Perl Compatible Regular Expressions, i.e. Perl, PHP and R], Python and Go).
254 254  
255 -Reduced version (without original SemVer "build metadata") from: [[https:~~/~~/regex101.com/r/Ly7O1x/3/>>url:https://regex101.com/r/Ly7O1x/3/]][[url:https://regex101.com/r/Ly7O1x/3/]]
156 +Reduced (% style="color:#e74c3c" %)version(%%) (without original SemVer "build metadata") from: [[https:~~/~~/regex101.com/r/Ly7O1x/3/>>url:https://regex101.com/r/Ly7O1x/3/]]
256 256  
257 -^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-
158 +> ^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<extension>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?$
258 258  
259 -9]\d*)(?:-(?P<extension>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-
260 -
261 -]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?$
262 -
263 263  And one with numbered capture groups instead (so cg1 = major, cg2 = minor, cg3 = patch and cg4 = extension) that is compatible with ECMA Script (JavaScript), PCRE (Perl Compatible Regular Expressions, i.e. Perl, PHP and R), Python and Go.
264 264  
265 -Reduced version (without original SemVer "build metadata") from: [[https:~~/~~/regex101.com/r/vkijKf/1/>>url:https://regex101.com/r/vkijKf/1/]][[url:https://regex101.com/r/vkijKf/1/]]
162 +Reduced (% style="color:#e74c3c" %)version(%%) (without original SemVer "build metadata") from:  [[https:~~/~~/regex101.com/r/vkijKf/1>>url:https://regex101.com/r/vkijKf/1/]]
266 266  
267 -^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-
164 +> ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?$
268 268  
269 -9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-
270 -
271 -][0-9a-zA-Z-]*))*))?$
272 -
273 273  **Must I adopt semantic versioning rules when switching to SDMX 3.0?**
274 274  
275 -No. If backwards compatibility with pre-existing tools and processes is required, then it is possible to continue using the previous versioning scheme (with up to two version parts MAJOR.MINOR). Semantic versioning is indicated only for those use cases where a proper artefact versioning is required. If versioning does not apply to some or all of your artefacts, then rather migrate to non-versioned SDMX 3.0 artefacts.
168 +No. If backwards compatibility with pre-existing tools and processes is required, then it is possible to continue using the previous versioning scheme (with up to two (% style="color:#e74c3c" %)version(%%) parts MAJOR.MINOR). Semantic versioning is indicated only for those use cases where a proper [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] versioning is required. If versioning does not apply to some or all of your [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], then rather migrate to non-versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].
276 276  
277 -**May I mix artefacts that follow semantic versioning with artefacts that don't?**
170 +**May I mix [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that follow semantic versioning with [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that don't?**
278 278  
279 -Artefacts that are not (semantically) versioned may reference artefacts that are semantically versioned, but those are fully safe to use only when not extended. However, the reverse is not true: non-semantically-versioned artefacts do not offer change guarantees, and, therefore, should not be referenced by semantically versioned artefacts.
172 +[[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that are not (semantically) versioned may reference [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that are semantically versioned, but those are fully safe to use only when not extended. However, the reverse is not true: non-semantically-versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] do not offer change guarantees, and, therefore, should not be referenced by semantically versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].
280 280  
281 -**I have plenty of artefacts. I'm happy with my current versioning policy and I don't want to use SemVer! Can I still migrate to SDMX 3.0, and if so, what do I need to do?**
174 +**I have plenty of [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. I'm happy with my current versioning policy and I don't want to use SemVer! Can I still migrate to SDMX 3.0, and if so, what do I need to do?**
282 282  
283 -Yes, of course, you can. The introduction of semantic versioning is done in a way which is largely backward compatible with previous versions of the standard, so you can keep your existing 2-digit version numbers (1.0, 1.1, 2.0, etc.) if that is required by your current tools and processes. However, if not using SemVer then pre-SDMX 3.0 final artefacts will be migrated as non-final and mutable in SDMX 3.0. There are also many good reasons to move to SemVer, and the migration is encouraged. Be assured that there will be tools out there that will assist you doing this in an efficient and convenient way.
176 +Yes, of course, you can. The introduction of semantic versioning is done in a way which is largely backward compatible with previous (% style="color:#e74c3c" %)versions(%%) of the standard, so you can keep your existing 2-digit (% style="color:#e74c3c" %)version(%%) numbers (1.0, 1.1, 2.0, etc.) if that is required by your current tools and processes. However, if not using SemVer then pre-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 final [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] will be migrated as non-final and mutable in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0. There are also many good reasons to move to SemVer, and the migration is encouraged. Be assured that there will be tools out there that will assist you doing this in an efficient and convenient way.
284 284  
285 285  **I have plenty of artefacts versioned 'X.Y'. I want to make some of them immutable, and enjoy the benefits provided by semantic versioning. Some other artefacts however must remain mutable (i.e. non final). However, in both cases, I'd like adopt the semantic versioning. What do I need to do?**
286 286  
287 -For artefacts that will be made immutable and are therefore safe to use, simply append a '.0' to the current version (use X.Y.0) when migrating to Semantic Versioning. E.g., if the version of your artefact is currently 1.10, then migrate to 1.10.0.
180 +For [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that will be made immutable and are therefore safe to use, simply append a '.0' to the current (% style="color:#e74c3c" %)version(%%) (use X.Y.0) when migrating to Semantic Versioning. E.g., if the (% style="color:#e74c3c" %)version(%%) of your [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is currently 1.10, then migrate to 1.10.0.
288 288  
289 -For artefacts that remain mutable, and therefore do not bring the guarantees of semantic versioning, if you want to benefit from the advantages of semantic versioning, then simply append '.0-notfinal' to the version string. So, if the version of your artefact is currently 1.10, use 1.10.0-notfinal instead. Indeed, other extensions can be used depending on your use case.
182 +For [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that remain mutable, and therefore do not bring the guarantees of semantic versioning, if you want to benefit from the advantages of semantic versioning, then simply append '.0-notfinal' to the (% style="color:#e74c3c" %)version(%%) string. So, if the (% style="color:#e74c3c" %)version(%%) of your [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is currently 1.10, use 1.10.0-notfinal instead. Indeed, other extensions can be used depending on your use case.
290 290  
291 291  **I have adopted SDMX 3.0 with the semantic versioning conventions for the version strings of all my artefacts, regardless of whether these are stable (e.g. 1.0.0) or unstable (e.g. 1.0.0-notfinal, 1.0.0-draft, etc.). However, I still receive artefacts from organizations that have not yet adopted SemVer conventions for the version strings. How should I treat these?**
292 292  
293 -The only artefacts that are safe to use, are those that are semantically versioned. Starting with SDMX 3.0, these artefacts MUST use the SEMVER version string to indicate this fact and the version string of these artefacts MUST be expressed as X.Y.Z (e.g. 2.1.0). Extended versions bring some limited guarantees for changes.
186 +The only [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that are safe to use, are those that are semantically versioned. Starting with [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, these [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] MUST use the SEMVER (% style="color:#e74c3c" %)version(%%) string to indicate this fact and the (% style="color:#e74c3c" %)version(%%) string of these [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] MUST be expressed as X.Y.Z (e.g. 2.1.0). Extended (% style="color:#e74c3c" %)versions(%%) bring some limited guarantees for changes.
294 294  
295 -All other artefacts are in principle unsafe. They might be safe in practice but the SDMX standard does not bring any guarantees in that respect, and these artefacts may change in unpredictable ways.
188 +All other [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] are in principle unsafe. They might be safe in practice but the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard does not bring any guarantees in that respect, and these [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] may change in unpredictable ways.
296 296  
297 -In practice, the migration approach will often mirror the way in which organisations have migrated between earlier SDMX versions. Rarely, the new data models used mixed SDMX standard versions in their dependencies, and if they did then standard conversions were put in place. A typical method is to first migrate the re-used artefacts from the previous SDMX version to SDMX 3.0 and while doing so to apply the appropriate new semantic version string. From that point onwards, you can enjoy the advantages of the new SDMX versioning features for all those artefacts that require appropriate versioning.
190 +In practice, the migration approach will often mirror the way in which organisations have migrated between earlier [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#e74c3c" %)versions(%%). Rarely, the new data models used mixed [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard (% style="color:#e74c3c" %)versions(%%) in their dependencies, and if they did then standard conversions were put in place. A typical method is to first migrate the re-used [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] from the previous [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#e74c3c" %)version(%%) to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 and while doing so to apply the appropriate new semantic (% style="color:#e74c3c" %)version(%%) string. From that point onwards, you can enjoy the advantages of the new [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning features for all those [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that require appropriate versioning.
1750077413040-228.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +70.3 KB
Content
1750077431756-519.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +33.3 KB
Content