From 42d7213e121b4c98022363244b6b6b733378f167 Mon Sep 17 00:00:00 2001 From: decentral1se Date: Fri, 26 Mar 2021 01:01:19 +0100 Subject: [PATCH] Add version notes for apps --- docs/packager-guide.md | 16 ++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 17 insertions(+) create mode 100644 docs/packager-guide.md diff --git a/docs/packager-guide.md b/docs/packager-guide.md new file mode 100644 index 00000000..a51f2272 --- /dev/null +++ b/docs/packager-guide.md @@ -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 `~` 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`. diff --git a/mkdocs.yml b/mkdocs.yml index 32e7b7c5..fd02a5d4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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