From 78587d4f52e2f5fc0130dfe4b36379caf7afcad5 Mon Sep 17 00:00:00 2001 From: Markus Storm Date: Sat, 12 Aug 2023 08:08:26 +0200 Subject: [PATCH] OHian branch stable -> legacy Signed-off-by: Markus Storm --- NEWS.md | 21 ++++++++------------- docs/CHANGELOG.md | 8 ++++++++ docs/openhabian.md | 18 ++++++++++-------- functions/openhabian.bash | 4 ++-- 4 files changed, 28 insertions(+), 23 deletions(-) diff --git a/NEWS.md b/NEWS.md index 49b270f93..269520834 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,22 +2,17 @@ Hit tab to unselect buttons and scroll through the text using UP/DOWN or PGUP/PGDN. All announcements are stored in `/opt/openhabian/docs/CHANGELOG.md` for you to lookup. +## openHAB branch name changes to install openHAB 4 ## August 12, 2023 +The default openHABian branch name (this is something like the openHABian *version*) +changed from "openHAB3" to "openHAB". +The openHAB2 branch name changed from "stable" to "legacy". +You can use these names whenever you want to install a fresh openHABian system with +a specific openHAB version right in the first place using clonebranch= +in openhabian.conf. + ## IMPORTANT: installing openHAB 4 ## June 25, 2023 We will install openHAB 4 from now on. It will be the latest available milestone release until general availability of the openHAB 4 release. -## IMPORTANT: openHAB branch to install openHAB 4 ## June 3, 2023 -We will change the default branch name to "openHAB". If you are on the default branch openHAB3 so far, please use menu option 01 to change to openHAB branch when you upgrade/move to openHAB 4. - -## IMPORTANT: Java 17 is now the default ## March 22, 2023 -As upcoming openHAB 4 will require Java 17 to run, it's time to move so from -now on we install Java 17 by default. -NOTE: openHAB 3.X is said to work with but isn't thoroughly tested on Java 17 -so you might run into issues when you install 3.X. -This is also a request to all of you to gather and share experiences. -Please switch to (via menu) the *main* branch of openHABian or install it -right away as using the default branch (openHAB3) will keep installing Java 11 -for the time being. Let us know your feedback via forum. -You can also change java versions via menu or on install via openhabian.conf. diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 85b72f44c..ae031cc7e 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,3 +1,11 @@ +## openHAB branch name changes to install openHAB 4 ## August 12, 2023 +The default openHABian branch name (this is something like the openHABian *version*) +changed from "openHAB3" to "openHAB". +The openHAB2 branch name changed from "stable" to "legacy". +You can use these names whenever you want to install a fresh openHABian system with +a specific openHAB version right in the first place using clonebranch= +in openhabian.conf + ## IMPORTANT: installing openHAB 4 ## June 25, 2023 We will install openHAB 4 from now on. It will be the latest available milestone release until general availability of the openHAB 4 release. diff --git a/docs/openhabian.md b/docs/openhabian.md index b64f31c27..17e1ace56 100644 --- a/docs/openhabian.md +++ b/docs/openhabian.md @@ -66,12 +66,12 @@ The included **openHABian Configuration Tool** [`openhabian-config`](#openhabian ## On openHAB 4, 3 and 2 openHABian will install **openHAB 4** and Java 17 by default. openHAB 2 will continue to work on openHABian, but openHAB 2 support is no longer maintained. -If you need openHAB 2 support please use the `stable` branch of openHABian. +If you need openHAB 2 support please use the `legacy` branch of openHABian. You can switch branches using menu option 01 in `openhabian-config` but ATTENTION you cannot up- or downgrade this way and you cannot arbitrarily change versions. There's a high risk you mess up your system if you do. ### Deploying openHAB 2 or 3 -The openHABian image will install openHAB 4 by default, to have it install openHAB 2 or 3 right from the beginning, set `clonebranch=stable` or `clonebranch=openHAB3` in `openhabian.conf` before first boot. +The openHABian image will install openHAB 4 by default, to have it install openHAB 2 or 3 right from the beginning, set `clonebranch=legacy` or `clonebranch=openHAB3` in `openhabian.conf` before first boot. ## Upgrading openHAB 2 to current openHAB For openHABian users still running openHAB 2.X, `openhabian-config` offers to migrate the openHABian environment and install current openHAB for you. @@ -148,9 +148,11 @@ These are what we develop and test openHABian against. We provide code that is reported "as-is" to run on Ubuntu but we do **not support Ubuntu** so please don't open issues for this (PRs then again are welcome). Several optional components such as WireGuard or Homegear are known to expose problems on Ubuntu. -We expect you to use the current stable distribution 'bullseye' for Debian (x86). The current Raspberry Pi image is based on this, too. -To install openHABian on anything older or newer may work or not. +We expect you to use the current stable distribution `bullseye` for Debian (x86). The current Raspberry Pi image is based on this, too. +To install openHABian on anything older or newer may work or not. `bookworm` may work but it is not yet supported. If you do and encounter issues, you may need to upgrade first or to live with the consequences of running an OS on the edge of software development. +Note: With openHAB 4 and Java 17, `buster` is no longer reported. +There'll be issues when you upgrade Java 11->17 on `buster` so upgrade your OS to `bullseye` before attempting to upgrade openHAB. ### 64 bit? RPi 3 and 4 have a 64 bit processor and you may want to run openHAB in 64 bit. @@ -549,13 +551,13 @@ Consult the [debug guide](openhabian-DEBUG.md) and move on from there. #### Can I switch openHAB 2 and 3 via openHABian branches? -openHABian installs the latest stable build of openHAB. -The standard openHABian `openHAB` and `main` branches will install the new openHAB version 4 and the old `openHAB3` and `stable` branch will install the old openHAB version 3 and 2, respectively. +openHABian installs the latest release build of openHAB. +The standard openHABian `openHAB` and `main` branches will install the new openHAB version 4 and the old `openHAB3` and `legacy` branches will install the old openHAB version 3 or 2, respectively. You can migrate between versions by selecting the corresponding 4X menu option. That should also result in an openHABian branch change. -If you want to choose from stable, snapshot or milestone releases, please do so via `openhabian-config` tool (also menu 4X). +If you want to choose from release (stable), snapshot or milestone releases, please do so via `openhabian-config` tool (also menu 4X). Note this will **not** result in any openHABian branch change. -Switching from stable to newer development releases might introduce changes and incompatibilities, so please be sure to make a full openHAB backup first! +Switching to newer development releases might introduce changes and incompatibilities, so please be sure to make a full openHAB backup first! Check the Linux installation article for all needed details: [Linux: Changing Versions](linux.html#changing-versions) diff --git a/functions/openhabian.bash b/functions/openhabian.bash index 0a20d19ec..fbbff2f91 100644 --- a/functions/openhabian.bash +++ b/functions/openhabian.bash @@ -185,7 +185,7 @@ openhabian_update() { elif [[ -n $INTERACTIVE ]]; then radioOptions=("release" "most recommended version that supports openHAB 4 (openHAB branch)" "OFF") radioOptions+=("latest" "the latest of openHABian, not well tested (main branch)" "OFF") - radioOptions+=("legacy" "use for openHAB 2.x support (legacy stable branch)" "OFF") + radioOptions+=("legacy" "use for openHAB 2.x support (legacy branch)" "OFF") case "$current" in "openHAB") @@ -198,7 +198,7 @@ openhabian_update() { radioOptions[5]="ON" ;; - "openHAB2"|"stable") + "openHAB2"|"legacy"|"stable") branchLabel="the legacy version of openHABian" radioOptions[8]="ON" ;;