Skip to content

Commit 50a02fd

Browse files
document app versions back+front
1 parent 1ab2a4f commit 50a02fd

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

installation/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ We recommend you update your Marble version at least every few weeks.
158158

159159
- Latest version: Check releases page
160160
- Support policy: We only support the latest version. You should upgrade regularly to stay on a supported version.
161+
- Marble app versions guide: see [versions documentation](./versions.md)
161162
- Migration path: You must upgrade versions one at a time in sequence (e.g. v0.35 -> v0.36 -> v0.37). Skipping versions is not recommended.
162163

163164
## Getting Help

installation/versions.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Release versions
2+
3+
New versions of the Marble app are released about every week. The version numbers are of the format "vX.Y.Z", where X, Y and Z are numbers.
4+
Every version of the Marble app correponds to a pair of versions of the backend and frontend executables. A pair of (backend version, frontend version) that are together in a release are compatible.
5+
Note that version "vX.Y.Z" of the Marble app will not necessarily use the same versions "vX.Y.Z" of the backend and frontend. Typically, the patch version "Z" (and in rare cases, the minor version "Y") may be different.
6+
7+
The mapping of `Marble version => backend and frontend versions` can be found in the following way:
8+
For a given release of the Marble app (= release tag on the https://github.com/checkmarble/marble repository),
9+
10+
- `x-backend-image-version` and `x-frontend-image-version` can be found at the top of the docker-compose.yaml file of the repository
11+
- the relevant version tags can also be found in the `kubernetes/.versions` file

0 commit comments

Comments
 (0)