Add version notes for apps

This commit is contained in:
decentral1se 2021-03-26 01:01:19 +01:00
parent cefb2fc2ef
commit 42d7213e12
No known key found for this signature in database
GPG Key ID: 92DAD76BD9567B8A
2 changed files with 17 additions and 0 deletions

16
docs/packager-guide.md Normal file
View File

@ -0,0 +1,16 @@
---
title: Packager guide
---
## How apps are versioned
We simply take the version of the packaged app to be the same as the version of
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 `<version>~<revision>` 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`.

View File

@ -44,6 +44,7 @@ nav:
- Consider Docker security hardening practices: hardening.md
- Scale an application up to handle more traffic: scale.md
- Roll an application back to a previous version: rollback.md
- Packager guide: packager-guide.md
- Frequently asked questions: faq.md
- Roadmap: roadmap.md
- Contributing guide: contribute.md