Stereotype «Release»
JEAF Generator allows release note information to be defined directly in the UML model using the stereotypes: «ReleaseUnit», «Release», «ChangeDescription» and «ReleaseNotesEntry».
Stereotype «Release» marks a package representing a specific artifact release (e.g., 1.2.3).
As version number of the release the package name will be used.
| Stereotype | «Release» |
|
|---|---|---|
| Applicable Elements | Package |
|
| Tagged Values | ||
| Name | Type | Description |
umlModelRevision |
int |
Revision of the UML model that was used for a the release. |
releaseDate |
String |
Date when the release was published. Expected date format is yyyy-mm-dd. |
compatibilityInfos |
CompatibilityType |
Compatibility information about a release. Currently the following values can be used: - STRICT_FORWARD_COMPATIBLE: The release is strictly forward compatible, meaning that consumers of an artifact can work with newer versions than the providers. This also implies that the provider does not need to be deployed before the consumers.If forward compatibility is provided at all, it is usually limited to the same major version. - API_FORWARD_COMPATIBLE: The release is forward compatible from an API perspective. This means that, in general, a client can work with a newer version of an API than the provider. However, unlike strict forward compatibility, the new API version must be deployed on the provider side first.Example: A request property of a REST service changes from mandatory to optional. From an API perspective, this is a forward-compatible change. However, from a runtime perspective, requests may still be rejected if the property is missing until the REST service has been updated to accept the now-optional property. - BACKWARD_COMPATIBLE: The release is backward compatible. This means that consumers can work with an older version than providers.- BREAKING: The release contains changes that are not compatible with previous versions. According to Semantic Versioning (SemVer), such changes should only occur in new major releases.Notes - Depending in the type of an artifact a “provider” can be a REST service or also an event source or something else that provides any kind of information to a consumer. - Same also applies to the “consumer”. There is might be a REST client or a event consumer or something else. |
oldestSupportedVersion |
String |
|
released |
Boolean |
Tag defines if a version was already released or not. This information may be used during release notes creation. |
Generated by JEAF Generator