|
2 | 2 |
|
3 | 3 | This document provides guidelines on versioning in SDMX, including the following:
|
4 | 4 |
|
5 |
| -* Documenting "how-to" version SDMX artefacts following "semantic versioning;" |
6 |
| -* Documenting best practices for wildcarding dependencies; |
7 |
| -* Documenting best practices around extensions; and |
8 |
| -* Documenting best practices for implementing semantic versioning in an existing SDMX environment. |
| 5 | +- Documenting "how-to" version SDMX artefacts following "semantic versioning;" |
| 6 | +- Documenting best practices for wildcarding dependencies; |
| 7 | +- Documenting best practices around extensions; and |
| 8 | +- Documenting best practices for implementing semantic versioning in an existing SDMX environment. |
9 | 9 |
|
10 | 10 | This document is broken down into the following sections:
|
11 | 11 |
|
12 |
| -* [Versioning in SDMX](Versioning%20in%20SDMX.md), which outlines how artefacts can be versioned in SDMX, what semantic versioning is, and how semantic versioning complements the SDMX standard. This document also provides recommendations on [Implementing semantic versioning in an existing SDMX enviroment](Versioning%20in%20SDMX.md#implementing-semantic-versioning-in-an-existing-sdmx-enviroment). |
13 |
| -* [General Recommendations for Maintainable Artefacts](./General%20Recommendations%20for%20Maintainable%20Artefacts.md), which details actions applicable to any maintainable artefact and how those actions impact versioning. |
14 |
| -* [Artefact Specific Recommendations](./Artefact%20Specific%20Recommendations/), which detail how each action made to a maintainable artefact can impact it's version and what wildcarding |
15 |
| -considerations should be considered within that artefact. |
| 12 | +- [Versioning in SDMX](Versioning%20in%20SDMX.md), which outlines how artefacts can be versioned in SDMX, what semantic versioning is, and how semantic versioning complements the SDMX standard. This document also provides recommendations on [Implementing semantic versioning in an existing SDMX enviroment](Versioning%20in%20SDMX.md#implementing-semantic-versioning-in-an-existing-sdmx-enviroment). |
| 13 | +- [General Recommendations for Maintainable Artefacts](./General%20Recommendations%20for%20Maintainable%20Artefacts.md), which details actions applicable to any maintainable artefact and how those actions impact versioning. |
| 14 | +- [Artefact Specific Recommendations](./Artefact%20Specific%20Recommendations/), which detail how each action made to a maintainable artefact can impact it's version and what wildcarding considerations should be considered within that artefact. |
16 | 15 |
|
17 | 16 | ## Conventions Used in These Guidelines
|
18 | 17 |
|
19 | 18 | ### Minimum Version Changes
|
20 | 19 |
|
21 | 20 | In this document, when we recommend a minimum version change, it means the following:
|
22 | 21 |
|
23 |
| -| Minimum Version Change | Action | |
24 |
| -|:----------------------:|--------| |
25 |
| -| Major | Increment the first digit in the version number | |
26 |
| -| Minor | Increment the first or second digit in the version number | |
27 |
| -| Patch | Increment the first or second or third digit in the version number | |
| 22 | +| Minimum Version Change | Action | |
| 23 | +| :--------------------: | ------------------------------------------------------------------ | |
| 24 | +| Major | Increment the first digit in the version number | |
| 25 | +| Minor | Increment the first or second digit in the version number | |
| 26 | +| Patch | Increment the first or second or third digit in the version number | |
28 | 27 |
|
29 | 28 | ### Wildcarding References
|
30 | 29 |
|
31 | 30 | When referring to wildcarding, the following conventions are used:
|
32 | 31 |
|
33 |
| -| Level | Format | Meaning | |
34 |
| -|:-----:|--------|---------| |
35 |
| -| Patch | X.Y.Z+ | This matches the *latest available stable semantic* version of an artefact in form of **`x.y.z`** where `x.y.z` >= `X.Y.Z`. | |
36 |
| -| Minor | X.Y+.Z | This matches the *latest available stable semantic* version of an artefact in form of **`X.y.z`** where `y.z` >= `Y.Z`. | |
37 |
| -| Major | X+.Y.Z | This matches the *latest available stable semantic* version of an artefact in form of **`X.Y.z`** where `z` >= `Z`. | |
| 32 | +| Level | Meaning | Format | |
| 33 | +| :---: | ------- | --------------------------------------------------------------------------------------------------------------------------- | |
| 34 | +| Patch | X.Y.Z+ | This matches the _latest available stable semantic_ version of an artefact in form of **`x.y.z`** where `x.y.z` >= `X.Y.Z`. | |
| 35 | +| Minor | X.Y+.Z | This matches the _latest available stable semantic_ version of an artefact in form of **`X.y.z`** where `y.z` >= `Y.Z`. | |
| 36 | +| Major | X+.Y.Z | This matches the _latest available stable semantic_ version of an artefact in form of **`X.Y.z`** where `z` >= `Z`. | |
38 | 37 |
|
39 | 38 | ### Wildcard Reference Icons
|
40 | 39 |
|
41 | 40 | The following icons are used to indicate recommendations for wildcard references:
|
42 | 41 |
|
43 |
| -| Icon | Meaning | |
44 |
| -|:----:|---------------| |
45 |
| -| 🟢 | There are no concerns with having a wildcard reference at this level. | |
46 |
| -| ⚠️ | Take care in having a wildcard reference at this level; specific concerns will be noted. | |
47 |
| -| 🟥 | Do not have a wildcard reference at this level. | |
| 42 | +| Icon | Meaning | |
| 43 | +| :--: | ---------------------------------------------------------------------------------------- | |
| 44 | +| 🟢 | There are no concerns with having a wildcard reference at this level. | |
| 45 | +| ⚠️ | Take care in having a wildcard reference at this level; specific concerns will be noted. | |
| 46 | +| 🟥 | Do not have a wildcard reference at this level. | |
0 commit comments