This repository has been archived by the owner on May 16, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 343
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documents the versioning and compatibility of cwa components.
- Loading branch information
1 parent
dfb12ba
commit f44275d
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Versioning | ||
All components of the Corona Warn App use [Semantic versioning](https://semver.org/). | ||
|
||
Given a version number MAJOR.MINOR.PATCH, increment the: | ||
|
||
- MAJOR version when you make incompatible API changes, | ||
- MINOR version when you add functionality in a backwards compatible manner, and | ||
- PATCH version when you make backwards compatible bug fixes. | ||
|
||
We plan to never deprecate outdated API versions. That means that even on MAJOR version changes our goal is to keep the old API functional. | ||
|
||
## Maintaining compatible versions | ||
|
||
Backend components will always remain compatible due to ongoing the availability of old API versions. | ||
|
||
To ensure that all clients use the current "state of the art" information in order to apply the respective algorithms the cwa-server component can deprecate older Android and iOS app versions. The current minimum required app versions can be viewed in the [App Version Config](https://github.com/corona-warn-app/cwa-server/blob/master/services/distribution/src/main/resources/master-config/app-version-config.yaml). | ||
The `app-version-config` is checked by the mobile clients on a regular basis. When the client detects that the required `min` version is higher than the current installed version, the user will be notified about the need to update the app. The app will not be useable until this update is performed. | ||
|
||
|
||
# Changelogs | ||
Changelogs can be found the in release notes attached to git tags, e.g. [Android App, Version 1.0.3](https://github.com/corona-warn-app/cwa-app-android/releases/tag/1.0.3). |