From d187478d72aedddab24cb1c7992368c3fc2bc44e Mon Sep 17 00:00:00 2001 From: decentral1se Date: Wed, 5 May 2021 20:22:35 +0200 Subject: [PATCH] Revise version notes --- docs/packager-guide.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/packager-guide.md b/docs/packager-guide.md index a51f22723..c0119e13c 100644 --- a/docs/packager-guide.md +++ b/docs/packager-guide.md @@ -9,8 +9,12 @@ the main `app` service in the `compose.yml` file. So, if you are deploying `gitea/gitea:1.13.4` then the version of your Gitea app package version is `1.13.4`. -However, most apps have underlying services like databases. When a new version -is published and available in the `compose.yml` but then `app` service version -has not changed, then we are using a `~` syntax. So, if you -are still on `1.13.4` for Gitea but you have `mariadb:10.6` upgraded from -`mariadb:10.5` then the Gitea app package version would be `1.13.4~1`. +Additionally, most apps have underlying services like databases and/or caches. +When a new version is published and available in the `compose.yml` we use the +`_` syntax. So, if you are still on `1.13.4` for Gitea but +you have `mariadb:10.6` upgraded from `mariadb:10.5` then the Gitea app package +version would be `1.13.4_1`. + +Our high level goals of app versioning on this project are not to invent a new +versioning system. Therefore, we try to follow the upstream versioning as much +as possible. This scheme is still a work in progress.