From 1d2f594fc602228bef6ad41f2078bf4e5b5403af Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Thu, 27 Jul 2023 15:46:20 +0200 Subject: [PATCH] update docs about versioning (#2043) #2040 did point out, it needs to be better clarified --- docs/docs/80-downloads.md | 9 +++++---- docs/src/pages/faq.md | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/docs/80-downloads.md b/docs/docs/80-downloads.md index 1201f25ce..e18c00e42 100644 --- a/docs/docs/80-downloads.md +++ b/docs/docs/80-downloads.md @@ -13,10 +13,11 @@ To find out more about the differences between the two releases, please read the ## Docker images Image variants: -* The `latest` image is the latest stable release -* The `vX.X.X` images are stable releases -* The `vX.X` images are based on the latest patch version of a specific minor release (see [Semver](https://semver.org/)) -* The `next` images are based on the current master branch and should not be used for production environments + +- The `latest` image is the latest stable release +- The `vX.X.X` images are stable releases +- The `vX.X` images are based on the current release branch (e.g. `release/v1.0`) and can be used to get bugfixes asap +- The `next` images are based on the current `main` branch and should not be used for production environments ``` bash # server diff --git a/docs/src/pages/faq.md b/docs/src/pages/faq.md index c465f9f00..70552759d 100644 --- a/docs/src/pages/faq.md +++ b/docs/src/pages/faq.md @@ -18,7 +18,7 @@ Woodpecker is having two different kinds of releases: **stable** and **next**. The **stable** releases (currently version 0.15) is a long-term supported (LTS) stable version. The stable releases are only getting bugfixes. -The **next** release contains all bugfixes and features from `master`. Normally it should be pretty stable, but as its frequently updated, it might contain some bugs from time to time. +The **next** release contains all bugfixes and features from `main` branch. Normally it should be pretty stable, but as its frequently updated, it might contain some bugs from time to time. If you want all (new) features of Woodpecker and are willing to accept some possible bugs from time to time, you should use the next release otherwise use the stable release.