Skip to Content

Wiki source code of 14 ANNEX Semantic Versioning

Version 15.1 by Artur on 2025/05/27 15:51
Hide last authors
Helena 2.3 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Helena 2.1 4
5 == 14.1 Introduction to Semantic Versioning ==
6
Artur 12.1 7 In the world of versioned data modelling exists a dreaded place called "dependency hell." The bigger your data model through organisational, national or international harmonisation grows and the more [[artefacts>>doc:Glossary.Artefact.WebHome]] you integrate into your modelling, the more likely you are to find yourself, one day, in this pit of despair.
Helena 2.1 8
Artur 12.1 9 In systems with many dependencies, releasing new [[artefact>>doc:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)versions(%%) can quickly become a nightmare. If the dependency specifications are too tight, you are in danger of (% style="color:#e74c3c" %)version(%%) lock (the inability to upgrade an [[artefact>>doc:Glossary.Artefact.WebHome]] without having to release new (% style="color:#e74c3c" %)versions(%%) of every dependent [[artefact>>doc:Glossary.Artefact.WebHome]]). If dependencies are specified too loosely, you will inevitably be bitten by (% style="color:#e74c3c" %)version(%%) promiscuity (assuming compatibility with more future (% style="color:#e74c3c" %)versions(%%) than is reasonable). Dependency hell is where you are when (% style="color:#e74c3c" %)version(%%) lock and/or (% style="color:#e74c3c" %)version(%%) promiscuity prevent you from easily and safely moving your data modelling forward.
Helena 2.1 10
Artur 12.1 11 As a very successful solution to the similar problem in software development, "Semantic Versioning" [[__semver.org__>>https://semver.org/]] proposes a simple set of rules and requirements that dictate how (% style="color:#e74c3c" %)version(%%) numbers are assigned and incremented. These rules make also perfect sense in the world of versioned data modelling and help to solve the "dependency hell" encountered with previous (% style="color:#e74c3c" %)versions(%%) of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]. [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 applies thus the Semantic Versioning rules on all versioned [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:Glossary.Artefact.WebHome]]. Once you release a versioned [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:Glossary.Artefact.WebHome]], you communicate changes to it with specific increments to your (% style="color:#e74c3c" %)version(%%) number.
Helena 2.1 12
Artur 14.1 13 **This [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0(.0) specification inherits the original **[[__**semver.org**__>>https://semver.org]]** 2.0.0 wording (license: [[__Creative Commons - CC BY 3.0__>>https://creativecommons.org/licenses/by/3.0/]]) and applies it to versioned [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:Glossary.Artefact.WebHome]].** Under this scheme, (% style="color:#e74c3c" %)version(%%) numbers and the way they change convey meaning about the underlying data structures and what has been modified from one (% style="color:#e74c3c" %)version(%%) to the next.
Helena 2.1 14
15 == 14.2 Semantic Versioning Specification for SDMX 3.0(.0) ==
16
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
Artur 12.1 19 In the following, "versioned" [[artefacts>>doc:Glossary.Artefact.WebHome]] are understood to be semantically versioned [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc: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.
Helena 2.1 20
Artur 12.1 21 The following rules apply to versioned [[artefacts>>doc:Glossary.Artefact.WebHome]]:
Helena 2.1 22
Artur 12.1 23 * All versioned [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:Glossary.Artefact.WebHome]] MUST specify a (% style="color:#e74c3c" %)version(%%) number.
24 * The (% style="color:#e74c3c" %)version(%%) number of immutable versioned [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc: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: 1.9.0 -> 1.10.0 -> 1.11.0.
25 * Once an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc: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:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)version(%%) is considered stable. Any modifications MUST be released as a new (% style="color:#e74c3c" %)version(%%).
26 * 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:Glossary.Artefact.WebHome]] SHOULD NOT be considered stable.
27 * (% style="color:#e74c3c" %)Version(%%) 1.0.0 defines the first stable [[artefact>>doc: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:Glossary.Artefact.WebHome]] changes.
28 * 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:Glossary.Artefact.WebHome]]. These are changes in the [[artefact>>doc:Glossary.Artefact.WebHome]]'s or [[artefact>>doc:Glossary.Artefact.WebHome]] element's names, descriptions and [[annotations>>doc:Glossary.Annotation.WebHome]] that MUST NOT alter their meaning.
29 * 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:Glossary.Artefact.WebHome]]. These are additional items in ItemScheme [[artefacts>>doc:Glossary.Artefact.WebHome]]. It MAY be incremented if substantial new information is introduced within the [[artefact>>doc: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.
30 * 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: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: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.
31 * 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:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc: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: 1.0.0-draft, 1.0.0-draft.1, 1.0.0-0.3.7, 1.0.0-x.7.z.92.
Artur 11.1 32 * 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 < 1.0.0-prerelease.11 < 1.0.0-rc.1 < 1.0.0.
Artur 12.1 33 * The reasons for (% style="color:#e74c3c" %)version(%%) changes MAY be documented in brief form in an [[artefact>>doc:Glossary.Artefact.WebHome]]'s [[annotation>>doc:Glossary.Annotation.WebHome]] of type "CHANGELOG".
Helena 2.1 34
35 == 14.3 Backus–Naur Form Grammar for Valid SDMX 3.0(.0) Semantic Versions ==
36
Helena 3.6 37 [[image:1747382317063-468.png]]
38 [[image:1747382367401-937.png||height="321" width="637"]]
Helena 2.1 39
40 == 14.4 Dependency Management in SDMX 3.0(.0): ==
41
Artur 12.1 42 MAJOR, MINOR or PATCH (% style="color:#e74c3c" %)version(%%) parts in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 [[artefact>>doc:Glossary.Artefact.WebHome]] references CAN be wildcarded using "+" as extension:
Helena 2.1 43
Artur 11.1 44 * X+.Y.Z means the currently latest available (% style="color:#e74c3c" %)version(%%) >= X.Y.Z
45 ** Example: "2+.3.1" means the currently latest available (% style="color:#e74c3c" %)version(%%) >="2.3.1" (even if not backwards compatible)
Artur 12.1 46 ** Typical use case: references in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Categorisations
Artur 11.1 47 * X.Y+.Z means the currently latest available backwards compatible (% style="color:#e74c3c" %)version(%%) >=X.Y.Z
48 ** 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")
Artur 12.1 49 ** Typical use case: references in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] DSD
Artur 11.1 50 * X.Y.Z+ means the currently latest available forwards and backwards compatible (% style="color:#e74c3c" %)version(%%) >= X.Y.Z
51 ** 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")
Artur 12.1 52 * Non-versioned and 2-digit (% style="color:#e74c3c" %)version(%%) [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:Glossary.Artefact.WebHome]] CAN reference any other non-versioned or versioned (whether SemVer or not) [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:Glossary.Artefact.WebHome]].
53 * Semantically versioned [[artefacts>>doc:Glossary.Artefact.WebHome]] MUST only reference other semantically versioned [[artefacts>>doc:Glossary.Artefact.WebHome]].
54 * Wildcarded references in a stable [[artefact>>doc:Glossary.Artefact.WebHome]] implicitly target only future stable (% style="color:#e74c3c" %)versions(%%) of the referenced [[artefacts>>doc:Glossary.Artefact.WebHome]] within the defined wildcard scope.
55 ** Example: The reference to "AGENCY_ID:CODELIST_ID(2.3+.1)" in an [[artefact>>doc:Glossary.Artefact.WebHome]] "AGENCY_ID:DSD_ID(2.2.1)" resolves to [[artefact>>doc:Glossary.Artefact.WebHome]] "AGENCY_ID:CODELIST_ID(2.4.3)" if that was currently the latest available stable (% style="color:#e74c3c" %)version(%%).
Helena 13.1 56 * Wildcarded references in a version-extended [[artefact>>doc:Glossary.Artefact.WebHome]] implicitly target future stable and version-extended (% style="color:#e74c3c" %)versions(%%) of the referenced [[artefacts>>doc:Glossary.Artefact.WebHome]] within the defined wildcard scope.
Artur 12.1 57 ** Example: The reference to "AGENCY_ID:CODELIST_ID(2.3+.1)" in an [[artefact>>doc:Glossary.Artefact.WebHome]] "AGENCY_ID:DSD_ID(2.2.1-draft)" resolves to [[artefact>>doc:Glossary.Artefact.WebHome]] "AGENCY_ID:CODELIST_ID(2.5.0-draft)" if that was currently the latest available (% style="color:#e74c3c" %)version(%%).
Helena 13.1 58 * References to specific version-extended [[artefacts>>doc:Glossary.Artefact.WebHome]] MAY be used, but those cannot be combined with a wildcard.
Artur 12.1 59 ** Example: The reference to "AGENCY_ID:CODELIST_ID(2.5.0draft)" in an [[artefact>>doc:Glossary.Artefact.WebHome]] "AGENCY_ID:DSD_ID(2.2.1)" resolves to [[artefact>>doc:Glossary.Artefact.WebHome]] "AGENCY_ID:CODELIST_ID(2.5.0-draft)", which might be subject to continued backwards compatible changes.
Helena 2.1 60
Helena 13.1 61 Because both, wildcarded references and references to version-extended [[artefacts>>doc:Glossary.Artefact.WebHome]], allow for changes in the referenced [[artefacts>>doc: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.
Helena 2.1 62
Artur 12.1 63 For references to non-dependent [[artefacts>>doc:Glossary.Artefact.WebHome]], MAJOR, MINOR or PATCH (% style="color:#e74c3c" %)version(%%) parts in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 [[artefact>>doc:Glossary.Artefact.WebHome]] references CAN alternatively be wildcarded using "*" as replacement:
Helena 2.1 64
Artur 11.1 65 ~* means all available (% style="color:#e74c3c" %)versions
Helena 2.1 66
67 == 14.5 Upgrade and conversions of artefacts defined with previous SDMX standard versions to Semantic Versioning ==
68
Artur 12.1 69 Because [[SDMX>>doc: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:Glossary.Artefact.WebHome]] in EDIFACT, [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 1.0, 2.0 or 2.1. SemVer can only be applied to structural [[artefacts>>doc:Glossary.Artefact.WebHome]] that are newly modelled with the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Information Model. Migrating to SemVer means migrating to the [[SDMX>>doc: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.
Helena 2.1 70
Artur 12.1 71 To migrate [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:Glossary.Artefact.WebHome]] created previously to [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0.0:
Helena 2.1 72
Artur 12.1 73 If the [[artefacts>>doc:Glossary.Artefact.WebHome]] do not need versioning, then the new [[artefacts>>doc:Glossary.Artefact.WebHome]] based on the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Information Model SHOULD remain as-is, e.g., a previous [[artefact>>doc: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:Glossary.Artefact.WebHome]].
Helena 2.1 74
Artur 12.1 75 If [[artefact>>doc:Glossary.Artefact.WebHome]] versioning is required and [[SDMX>>doc: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:
Helena 2.1 76
Artur 11.1 77 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:
Helena 2.1 78
Artur 11.1 79 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.
Helena 2.1 80
Artur 11.1 81 1. Replace the "isFinal=false" property by the (% style="color:#e74c3c" %)version(%%) extensions "-draft" (or alternatively "-unstable" or "-nonfinal" depending on the use case).
Helena 2.1 82
Artur 11.1 83 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.
Helena 2.1 84
Helena 13.1 85 If [[artefact>>doc: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., version=1.2) may continue to be used.
Helena 2.1 86
Artur 12.1 87 Note: Like for other not fully backwards compatible [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 features, also some cases of semantically versioned [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 [[artefacts>>doc:Glossary.Artefact.WebHome]] cannot be converted back to earlier [[SDMX>>doc: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).
Helena 2.1 88
89 == 14.6 FAQ for Semantic Versioning ==
90
91 **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?**
92
Artur 12.1 93 If all counterparts involved in the process and all tools used for its implementation are [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0-ready, then it is recommended to:
Helena 2.1 94
95 * in general, use semantic versioning;
Artur 12.1 96 * exceptionally, do not use versioning for [[artefacts>>doc:Glossary.Artefact.WebHome]] that do not require it, e.g. [[artefacts>>doc: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.
Helena 2.1 97
98 **How should I deal with revisions in the 0.y.z initial modelling phase?**
99
Artur 11.1 100 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.
Helena 2.1 101
102 **How do I know when to release 1.0.0?**
103
Artur 12.1 104 If your data model is being used in production, it should probably already be 1.0.0. If you have a stable [[artefact>>doc: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.
Helena 2.1 105
106 **Doesn't this discourage rapid modelling and fast iteration?**
107
Artur 12.1 108 Major (% style="color:#e74c3c" %)version(%%) zero is all about rapid modelling. If you're changing the [[artefact>>doc: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.
Helena 2.1 109
Artur 11.1 110 **If even the tiniest backwards incompatible changes to the public artefact require a major (% style="color:#e74c3c" %)version(%%) bump, won't I end up at (% style="color:#e74c3c" %)version(%%) 42.0.0 very rapidly?**
Helena 2.1 111
Artur 11.1 112 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.
Helena 2.1 113
Helena 13.1 114 **Documenting the version changes in an artefact's annotation of type "CHANGELOG" is too much work!**
Helena 2.1 115
Artur 12.1 116 It is your responsibility as a professional modeller to properly document the [[artefacts>>doc: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:Glossary.Artefact.WebHome]] are safe to reuse. In the long run, [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Semantic Versioning can keep everyone and everything running smoothly.
Helena 2.1 117
Artur 11.1 118 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(%%).
Helena 2.1 119
Helena 13.1 120 **What do I do if I accidentally release a backwards incompatible change as a minor version?**
Helena 2.1 121
Artur 12.1 122 As soon as you realise that you've broken the [[SDMX>>doc: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(%%).
Helena 2.1 123
Helena 13.1 124 **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)?**
Helena 2.1 125
Artur 12.1 126 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: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: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.
Helena 2.1 127
128 **How should I handle deprecating elements?**
129
Artur 12.1 130 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:Glossary.Reference area.WebHome]]). When you deprecate part of your stable [[artefact>>doc: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:Glossary.Code.WebHome]] but still keep the old country [[code>>doc:Glossary.Code.WebHome]]) and with a "CHANGELOG" [[annotation>>doc:Glossary.Annotation.WebHome]] announcing the deprecation (e.g. the intention to remove the old country [[code>>doc: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:Glossary.Artefact.WebHome]].
Helena 2.1 131
Helena 13.1 132 **Does SDMX 3.0.0 Semantic Versioning have a size limit on the version string?**
Helena 2.1 133
Artur 12.1 134 No, but use good judgement. A 255 character (% style="color:#e74c3c" %)version(%%) string is probably overkill, for example. In addition, specific [[SDMX>>doc: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".
Helena 2.1 135
Helena 13.1 136 **Is "v1.2.3" a semantic version?**
Helena 2.1 137
Artur 11.1 138 No, "v1.2.3" is not a semantic (% style="color:#e74c3c" %)version(%%). The semantic (% style="color:#e74c3c" %)version(%%) is "1.2.3".
Helena 2.1 139
140 **Is there a suggested regular expression (RegEx) to check an SDMX 3.0.0 Semantic Versioning string?**
141
142 There are two:
143
144 One with named groups for those systems that support them (PCRE [Perl Compatible Regular Expressions, i.e. Perl, PHP and R], Python and Go).
145
Artur 15.1 146 Reduced (% style="color:#e74c3c" %)version(%%) (without original SemVer "build metadata") from: [[__https:~~/~~/regex101.com/r/Ly7O1x/3/__https:~~/~~/regex101.com/r/Ly7O1x/3/>>https://regex101.comrLy7O1x3https:regex101.comrLy7O1x3]]
Helena 2.1 147
Helena 4.1 148 > ^(?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-]*))*))?$
Helena 2.1 149
150 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.
151
Artur 15.1 152 Reduced (% style="color:#e74c3c" %)version(%%) (without original SemVer "build metadata") from: [[__https:~~/~~/regex101.com/r/vkijKf/1/__https:~~/~~/regex101.com/r/vkijKf/1/>>https://regex101.comrvkijKf1https:regex101.comrvkijKf1]]
Helena 2.1 153
Helena 4.1 154 > ^(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-]*))*))?$
Helena 2.1 155
156 **Must I adopt semantic versioning rules when switching to SDMX 3.0?**
157
Artur 12.1 158 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:Glossary.Artefact.WebHome]] versioning is required. If versioning does not apply to some or all of your [[artefacts>>doc:Glossary.Artefact.WebHome]], then rather migrate to non-versioned [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 [[artefacts>>doc:Glossary.Artefact.WebHome]].
Helena 2.1 159
160 **May I mix artefacts that follow semantic versioning with artefacts that don't?**
161
Artur 12.1 162 [[Artefacts>>doc:Glossary.Artefact.WebHome]] that are not (semantically) versioned may reference [[artefacts>>doc: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:Glossary.Artefact.WebHome]] do not offer change guarantees, and, therefore, should not be referenced by semantically versioned [[artefacts>>doc:Glossary.Artefact.WebHome]].
Helena 2.1 163
164 **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?**
165
Artur 12.1 166 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:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 final [[artefacts>>doc:Glossary.Artefact.WebHome]] will be migrated as non-final and mutable in [[SDMX>>doc: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.
Helena 2.1 167
168 **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?**
169
Artur 12.1 170 For [[artefacts>>doc: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:Glossary.Artefact.WebHome]] is currently 1.10, then migrate to 1.10.0.
Helena 2.1 171
Artur 12.1 172 For [[artefacts>>doc: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:Glossary.Artefact.WebHome]] is currently 1.10, use 1.10.0-notfinal instead. Indeed, other extensions can be used depending on your use case.
Helena 2.1 173
174 **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?**
175
Artur 12.1 176 The only [[artefacts>>doc:Glossary.Artefact.WebHome]] that are safe to use, are those that are semantically versioned. Starting with [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, these [[artefacts>>doc: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: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.
Helena 2.1 177
Artur 12.1 178 All other [[artefacts>>doc:Glossary.Artefact.WebHome]] are in principle unsafe. They might be safe in practice but the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] standard does not bring any guarantees in that respect, and these [[artefacts>>doc:Glossary.Artefact.WebHome]] may change in unpredictable ways.
Helena 2.1 179
Artur 12.1 180 In practice, the migration approach will often mirror the way in which organisations have migrated between earlier [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#e74c3c" %)versions(%%). Rarely, the new data models used mixed [[SDMX>>doc: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:Glossary.Artefact.WebHome]] from the previous [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#e74c3c" %)version(%%) to [[SDMX>>doc: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:Glossary.Statistical data and metadata exchange.WebHome]] versioning features for all those [[artefacts>>doc:Glossary.Artefact.WebHome]] that require appropriate versioning.