|
11 | 11 | - [esmf-aspect-static-meta-model](#esmf-aspect-static-meta-model)
|
12 | 12 | - [esmf-aspect-model-validator](#esmf-aspect-model-validator)
|
13 | 13 | - [Version Handling](#version-handling)
|
14 |
| - - [SAMM Versioning](#samm-versioning) |
| 14 | + - [esmf-sdk Versioning](#esmf-sdk-versioning) |
15 | 15 | - [SAMM Java Implementation Packaging](#samm-java-implementation-packaging)
|
16 | 16 | - [SAMM CLI](#samm-cli)
|
17 | 17 | - [Artifact Generation facilities](#artifact-generation-facilities)
|
@@ -124,30 +124,27 @@ The model validator is also available through the [SAMM CLI](#samm-cli).
|
124 | 124 |
|
125 | 125 | ## Version Handling
|
126 | 126 |
|
127 |
| -SAMM does evolve over time. While measures are made to do this in a non-breaking manner, some |
128 |
| -changes cannot be carried out without the need to define a new, breaking version. Due to this fact |
129 |
| -it is important to understand the versioning concept that is applied to the SAMM, APIs and SDK |
| 127 | +SAMM and its SDKs evolve over time. While measures are taken to do this in a non-breaking manner, |
| 128 | +some changes cannot be carried out without the need to define a new, breaking version. Due to this |
| 129 | +fact it is important to understand the versioning concept that is applied to the SAMM, APIs and SDK |
130 | 130 | components that are derived from them.
|
131 | 131 |
|
132 |
| -In case of a prerelease there will be a postfix added and it will be released on Github. The way to |
133 |
| -access the artifact is described in [Github-Installing a |
134 |
| -package](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#installing-a-package) |
| 132 | +In case of a prerelease a postfix will be added to the version, such as `-M1`, and it will be |
| 133 | +released on Github. The way to access the artifact is described in the [Java Aspect Tooling |
| 134 | +Guide](https://eclipse-esmf.github.io/esmf-developer-guide/tooling-guide/java-aspect-tooling.html#versioning). |
135 | 135 |
|
136 |
| -### SAMM Versioning |
| 136 | +### esmf-sdk Versioning |
137 | 137 |
|
138 |
| -For SAMM, semantic versioning (`major.minor.micro`) is applied with the following rules: |
| 138 | +For the esmf-sdk, semantic versioning (`major.minor.micro`) is applied with the following rules: |
139 | 139 |
|
140 |
| -* A breaking change increases the `major` part |
141 |
| -* Backwards compatible new features increase the `minor` part |
142 |
| -* Changes to existing features or bug fixes increase the `micro` part |
| 140 | +* The `major` part designates the supported SAMM major version |
| 141 | +* A breaking change increases the `minor` part |
| 142 | +* Backwards compatible new features, changes to existing features or bugfixes increase the `minor` part |
143 | 143 |
|
144 |
| -A new SAMM version always comprises new releases of the SDK components that depend on SAMM, however |
145 |
| -not the other way round. New releases of SDK components may be crafted that are built on the |
| 144 | +A new SAMM version implies new releases of the SDK components that depend on this SAMM version, |
| 145 | +however not the other way round. New releases of SDK components may be released that are built on an |
146 | 146 | existing SAMM version.
|
147 | 147 |
|
148 |
| -The SDK component versions are otherwise not tied to the SAMM version, i.e., they may differ in any |
149 |
| -part of the version. |
150 |
| - |
151 | 148 | ### SAMM Java Implementation Packaging
|
152 | 149 |
|
153 | 150 | Complex applications might have the need to be implemented against different versions of the SAMM,
|
|
0 commit comments