From 07984dc91eb6aca865c27bb95e9b7f2fc2372760 Mon Sep 17 00:00:00 2001 From: d2eight Date: Tue, 27 Jan 2026 19:25:52 +0200 Subject: [PATCH 1/7] docker upgrade instructions --- _includes/docker-upgrade-instructions.md | 79 +++++++++++++++++++ _includes/upgrade-instructions.liquid | 2 + .../upgrade-instructions/docker/v4-0-x.md | 42 +--------- .../upgrade-instructions/docker/v4-1-x.md | 14 +--- .../upgrade-instructions/docker/v4-2-x.md | 42 +--------- .../upgrade-instructions/docker/v4-3-x.md | 14 +--- .../upgrade-instructions/docker/v4-0-x.md | 42 +--------- .../upgrade-instructions/docker/v4-1-x.md | 14 +--- .../upgrade-instructions/docker/v4-2-x.md | 42 +--------- .../upgrade-instructions/docker/v4-3-x.md | 14 +--- 10 files changed, 93 insertions(+), 212 deletions(-) create mode 100644 _includes/docker-upgrade-instructions.md diff --git a/_includes/docker-upgrade-instructions.md b/_includes/docker-upgrade-instructions.md new file mode 100644 index 0000000000..20919f7c2f --- /dev/null +++ b/_includes/docker-upgrade-instructions.md @@ -0,0 +1,79 @@ +{%- assign platform = "ThingsBoard CE" -%} +{%- assign current_version = include.version -%} +{%- assign current_version_with_platform = current_version -%} +{%- assign previous_version = include.prev_version -%} +{%- assign update_status = include.update_status | default: "true" -%} +{%- assign applicable_versions = include.applicable_versions -%} +{%- assign x_status = include.x -%} + +{% if docsPrefix == "pe/" %} +{%- assign platform = "ThingsBoard PE" -%} +{%- assign current_version_with_platform = current_version | append: "pe" -%} +{% endif %} + +{%- assign curr_parts = current_version | split: "." -%} +{%- assign prev_parts = previous_version | split: "." -%} + +{%- assign curr_major = curr_parts[0] -%} +{%- assign curr_minor = curr_parts[1] -%} + +{%- assign prev_major = prev_parts[0] -%} +{%- assign prev_minor = prev_parts[1] -%} + +{%- assign previous_version_anchor = previous_version | replace: ".", "" -%} + +{%- assign previous_version_path = prev_major | append: "-" | append: prev_minor | append: "-x" -%} + +{%- assign use_external_link = false -%} +{%- if curr_major != prev_major or curr_minor != prev_minor -%} +{%- assign use_external_link = true -%} +{%- endif -%} + +{%- assign prev_parts = previous_version | split: "." -%} +{%- assign prev_major = prev_parts[0] -%} +{%- assign prev_minor = prev_parts[1] -%} + +### Upgrading {{ platform }} to {{ current_version }} + +{%- if x_status == "true" -%} +{%- assign prev_version_label = prev_major | append: "." | append: prev_minor | append: ".x" -%} +{%- else -%} +{%- assign prev_version_label = previous_version -%} +{%- endif -%} + +{% if docsPrefix == "pe/" %} +{%- assign prev_version_label = prev_version_label | append: "PE" -%} +{% endif %} + +{% assign platform_hash = "#upgrading-thingsboard-ce-to-" %} +{% if docsPrefix == "pe/" %} +{%- assign platform_hash = "#upgrading-thingsboard-pe-to-" -%} +{% endif %} + +{%- if use_external_link -%} +{%- assign prev_version_href = "/docs/" | append: docsPrefix | append: "user-guide/install/upgrade-instructions/docker/v" | append: previous_version_path | append: "/" | append: platform_hash | append: previous_version_anchor -%} +{%- else -%} +{%- assign prev_version_href = platform_hash | append: previous_version_anchor -%} +{%- endif -%} + +{% capture difference %} +**NOTE:** +
+These upgrade steps are applicable for ThingsBoard version {{ prev_version_label }}{% if applicable_versions %}{% assign versions = applicable_versions | split: "," %}{% for v in versions %} and ThingsBoard version {{ v | strip }}{% endfor %}{% endif %}. +In order to upgrade to {{ current_version_with_platform | upcase }} you need to [**upgrade to {{ prev_version_label }} first**]({{ prev_version_href }}). +{% endcapture %} +{% include templates/info-banner.md content=difference %} + +#### {{ platform }} service upgrade + +{% assign skipUpgrade = false %} +{% if update_status == "false" %} +{% assign skipUpgrade = true %} +{% endif %} + +{% if docsPrefix == "pe/" %} +{% assign pe_version = version | append: "PE" %} +{% include docs/pe/user-guide/install/docker-upgrade-steps.md version=pe_version skipUpgrade=skipUpgrade %} +{% else %} +{% include docs/user-guide/install/docker-upgrade-steps.md version=version skipUpgrade=skipUpgrade %} +{% endif %} diff --git a/_includes/upgrade-instructions.liquid b/_includes/upgrade-instructions.liquid index 597f9c884e..fe2825772a 100644 --- a/_includes/upgrade-instructions.liquid +++ b/_includes/upgrade-instructions.liquid @@ -41,6 +41,8 @@ {% include ubuntu-upgrade-instructions.md version=display_version prev_version=display_prev_version x=data.x update_status=data.upgrade applicable_versions=applicable_versions manual_version_upgrade=data.manual-version-upgrade manual_version_upgrade_label=data.manual-version-upgrade-label %} {% elsif os == "centos" %} {% include centos-upgrade-instructions.md version=display_version prev_version=display_prev_version x=data.x update_status=data.upgrade applicable_versions=applicable_versions manual_version_upgrade=data.manual-version-upgrade manual_version_upgrade_label=data.manual-version-upgrade-label %} +{% elsif os == "docker" %} +{% include docker-upgrade-instructions.md version=display_version prev_version=display_prev_version x=data.x update_status=data.upgrade applicable_versions=applicable_versions %} {% endif %} {% endif %} diff --git a/docs/pe/user-guide/install/upgrade-instructions/docker/v4-0-x.md b/docs/pe/user-guide/install/upgrade-instructions/docker/v4-0-x.md index e3d5dd90e8..ea60538c63 100644 --- a/docs/pe/user-guide/install/upgrade-instructions/docker/v4-0-x.md +++ b/docs/pe/user-guide/install/upgrade-instructions/docker/v4-0-x.md @@ -12,44 +12,6 @@ effective-url: '/docs/pe/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard PE to 4.0.2 +{% assign docsPrefix = "pe/" %} -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.xPE and ThingsBoard version 4.0.xPE. In order to upgrade to 4.0.2PE you need to [**upgrade to 3.9.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker/v3-9-x/#upgrading-thingsboard-pe-to-391). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard PE service upgrade - -{% include docs/pe/user-guide/install/docker-upgrade-steps.md version="4.0.2PE" %} - -### Upgrading ThingsBoard PE to 4.0.1 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.xPE and ThingsBoard version 4.0.xPE. In order to upgrade to 4.0.1PE you need to [**upgrade to 3.9.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker/v3-9-x/#upgrading-thingsboard-pe-to-391). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard PE service upgrade - -{% include docs/pe/user-guide/install/docker-upgrade-steps.md version="4.0.1PE" %} - -### Upgrading ThingsBoard PE to 4.0.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.xPE. In order to upgrade to 4.0PE you need to [**upgrade to 3.9.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker/v3-9-x/#upgrading-thingsboard-pe-to-391). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard PE service upgrade - -{% include docs/pe/user-guide/install/docker-upgrade-steps.md version="4.0.0PE" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.0" os="docker" %} \ No newline at end of file diff --git a/docs/pe/user-guide/install/upgrade-instructions/docker/v4-1-x.md b/docs/pe/user-guide/install/upgrade-instructions/docker/v4-1-x.md index 92a8d12ff7..0ccd416677 100644 --- a/docs/pe/user-guide/install/upgrade-instructions/docker/v4-1-x.md +++ b/docs/pe/user-guide/install/upgrade-instructions/docker/v4-1-x.md @@ -12,16 +12,6 @@ effective-url: '/docs/pe/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard PE to 4.1.0 +{% assign docsPrefix = "pe/" %} -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.0.xPE. In order to upgrade to 4.1PE you need to [**upgrade to 4.0.2PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker/v4-0-x/#upgrading-thingsboard-pe-to-402). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard PE service upgrade - -{% include docs/pe/user-guide/install/docker-upgrade-steps.md version="4.1.0PE" %} +{% include upgrade-instructions.liquid family="4.1" os="docker" %} diff --git a/docs/pe/user-guide/install/upgrade-instructions/docker/v4-2-x.md b/docs/pe/user-guide/install/upgrade-instructions/docker/v4-2-x.md index 228d128392..ae9b3433ba 100644 --- a/docs/pe/user-guide/install/upgrade-instructions/docker/v4-2-x.md +++ b/docs/pe/user-guide/install/upgrade-instructions/docker/v4-2-x.md @@ -12,44 +12,6 @@ effective-url: '/docs/pe/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard PE to 4.2.1.1 +{% assign docsPrefix = "pe/" %} -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.1PE. In order to upgrade to 4.2.1.1PE you need to [**upgrade to 4.2.1PE first**](#upgrading-thingsboard-pe-to-421). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard PE service upgrade - -{% include docs/pe/user-guide/install/docker-upgrade-steps.md version="4.2.1.1PE" skipUpgrade="true" %} - -### Upgrading ThingsBoard PE to 4.2.1 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.xPE. In order to upgrade to 4.2.1PE you need to [**upgrade to 4.2PE first**](#upgrading-thingsboard-pe-to-420). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard PE service upgrade - -{% include docs/pe/user-guide/install/docker-upgrade-steps.md version="4.2.1PE" %} - -### Upgrading ThingsBoard PE to 4.2.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.1.xPE. In order to upgrade to 4.2PE you need to [**upgrade to 4.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker/v4-1-x/#upgrading-thingsboard-pe-to-410). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard PE service upgrade - -{% include docs/pe/user-guide/install/docker-upgrade-steps.md version="4.2.0PE" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.2" os="docker" %} \ No newline at end of file diff --git a/docs/pe/user-guide/install/upgrade-instructions/docker/v4-3-x.md b/docs/pe/user-guide/install/upgrade-instructions/docker/v4-3-x.md index 94bd0c5ae6..380b47b224 100644 --- a/docs/pe/user-guide/install/upgrade-instructions/docker/v4-3-x.md +++ b/docs/pe/user-guide/install/upgrade-instructions/docker/v4-3-x.md @@ -12,16 +12,6 @@ effective-url: '/docs/pe/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard PE to 4.3.0 +{% assign docsPrefix = "pe/" %} -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.1PE. In order to upgrade to 4.3PE you need to [**upgrade to 4.2.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker/v4-2-x/#upgrading-thingsboard-pe-to-421). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard PE service upgrade - -{% include docs/pe/user-guide/install/docker-upgrade-steps.md version="4.3.0PE" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.3" os="docker" %} \ No newline at end of file diff --git a/docs/user-guide/install/upgrade-instructions/docker/v4-0-x.md b/docs/user-guide/install/upgrade-instructions/docker/v4-0-x.md index e198c8016a..8010d55585 100644 --- a/docs/user-guide/install/upgrade-instructions/docker/v4-0-x.md +++ b/docs/user-guide/install/upgrade-instructions/docker/v4-0-x.md @@ -12,44 +12,4 @@ effective-url: '/docs/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard CE to 4.0.2 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.x and ThingsBoard version 4.0.x. In order to upgrade to 4.0.2 you need to [**upgrade to 3.9.x first**](/docs/user-guide/install/upgrade-instructions/docker/v3-9-x/#upgrading-thingsboard-ce-to-390). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-upgrade-steps.md version="4.0.2" %} - -### Upgrading ThingsBoard CE to 4.0.1 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.x. In order to upgrade to 4.0.1 you need to [**upgrade to 3.9.x first**](/docs/user-guide/install/upgrade-instructions/docker/v3-9-x/#upgrading-thingsboard-ce-to-390). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-upgrade-steps.md version="4.0.1" %} - -### Upgrading ThingsBoard CE to 4.0.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.x. In order to upgrade to 4.0 you need to [**upgrade to 3.9.x first**](/docs/user-guide/install/upgrade-instructions/docker/v3-9-x/#upgrading-thingsboard-ce-to-390). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-upgrade-steps.md version="4.0.0" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.0" os="docker" %} \ No newline at end of file diff --git a/docs/user-guide/install/upgrade-instructions/docker/v4-1-x.md b/docs/user-guide/install/upgrade-instructions/docker/v4-1-x.md index 3a4f9e9eb2..b407fd8d46 100644 --- a/docs/user-guide/install/upgrade-instructions/docker/v4-1-x.md +++ b/docs/user-guide/install/upgrade-instructions/docker/v4-1-x.md @@ -12,16 +12,4 @@ effective-url: '/docs/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard CE to 4.1.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.0.x. In order to upgrade to 4.1 you need to [**upgrade to 4.0.x first**](/docs/user-guide/install/upgrade-instructions/docker/v4-0-x/#upgrading-thingsboard-ce-to-400). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-upgrade-steps.md version="4.1.0" %} +{% include upgrade-instructions.liquid family="4.1" os="docker" %} \ No newline at end of file diff --git a/docs/user-guide/install/upgrade-instructions/docker/v4-2-x.md b/docs/user-guide/install/upgrade-instructions/docker/v4-2-x.md index 6b2d19e6e9..85e3cb631f 100644 --- a/docs/user-guide/install/upgrade-instructions/docker/v4-2-x.md +++ b/docs/user-guide/install/upgrade-instructions/docker/v4-2-x.md @@ -12,44 +12,4 @@ effective-url: '/docs/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard CE to 4.2.1.1 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.1. In order to upgrade to 4.2.1.1 you need to [**upgrade to 4.2.1 first**](#upgrading-thingsboard-ce-to-421). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-upgrade-steps.md version="4.2.1.1" skipUpgrade="true" %} - -### Upgrading ThingsBoard CE to 4.2.1 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.x. In order to upgrade to 4.2.1 you need to [**upgrade to 4.2.x first**](#upgrading-thingsboard-ce-to-420). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-upgrade-steps.md version="4.2.1" %} - -### Upgrading ThingsBoard CE to 4.2.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.1.x. In order to upgrade to 4.2 you need to [**upgrade to 4.1.x first**](/docs/user-guide/install/upgrade-instructions/docker/v4-1-x/#upgrading-thingsboard-ce-to-410). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-upgrade-steps.md version="4.2.0" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.2" os="docker" %} \ No newline at end of file diff --git a/docs/user-guide/install/upgrade-instructions/docker/v4-3-x.md b/docs/user-guide/install/upgrade-instructions/docker/v4-3-x.md index de5d036a99..e8f75ec984 100644 --- a/docs/user-guide/install/upgrade-instructions/docker/v4-3-x.md +++ b/docs/user-guide/install/upgrade-instructions/docker/v4-3-x.md @@ -12,16 +12,4 @@ effective-url: '/docs/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard CE to 4.3.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.1. In order to upgrade to 4.3 you need to [**upgrade to 4.2.1 first**](/docs/user-guide/install/upgrade-instructions/docker/v4-2-x/#upgrading-thingsboard-ce-to-421). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-upgrade-steps.md version="4.3.0" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.3" os="docker" %} \ No newline at end of file From c33f89a46a149ef98dfd66159acf240ac5605169 Mon Sep 17 00:00:00 2001 From: d2eight Date: Wed, 28 Jan 2026 14:50:20 +0200 Subject: [PATCH 2/7] docker compose upgrade instructions --- .../docker-compose-upgrade-instructions.md | 95 +++++++++++++++++++ _includes/upgrade-instructions.liquid | 2 + .../docker-compose/v4-0-x.md | 66 +------------ .../docker-compose/v4-1-x.md | 21 +--- .../docker-compose/v4-2-x.md | 66 +------------ .../docker-compose/v4-3-x.md | 22 +---- .../docker-compose/v4-0-x.md | 66 +------------ .../docker-compose/v4-1-x.md | 22 +---- .../docker-compose/v4-2-x.md | 66 +------------ .../docker-compose/v4-3-x.md | 22 +---- 10 files changed, 109 insertions(+), 339 deletions(-) create mode 100644 _includes/docker-compose-upgrade-instructions.md diff --git a/_includes/docker-compose-upgrade-instructions.md b/_includes/docker-compose-upgrade-instructions.md new file mode 100644 index 0000000000..bc1886fb2b --- /dev/null +++ b/_includes/docker-compose-upgrade-instructions.md @@ -0,0 +1,95 @@ +{%- assign platform = "ThingsBoard CE" -%} +{%- assign current_version = include.version -%} +{%- assign current_version_with_platform = current_version -%} +{%- assign previous_version = include.prev_version -%} +{%- assign update_status = include.update_status | default: "true" -%} +{%- assign applicable_versions = include.applicable_versions -%} +{%- assign x_status = include.x -%} + +{% if docsPrefix == "pe/" %} +{%- assign platform = "ThingsBoard PE" -%} +{%- assign current_version_with_platform = current_version | append: "pe" -%} +{% endif %} + +{%- assign curr_parts = current_version | split: "." -%} +{%- assign prev_parts = previous_version | split: "." -%} + +{%- assign curr_major = curr_parts[0] -%} +{%- assign curr_minor = curr_parts[1] -%} + +{%- assign prev_major = prev_parts[0] -%} +{%- assign prev_minor = prev_parts[1] -%} + +{%- assign previous_version_anchor = previous_version | replace: ".", "" -%} + +{%- assign previous_version_path = prev_major | append: "-" | append: prev_minor | append: "-x" -%} + +{%- assign use_external_link = false -%} +{%- if curr_major != prev_major or curr_minor != prev_minor -%} +{%- assign use_external_link = true -%} +{%- endif -%} + +{%- assign prev_parts = previous_version | split: "." -%} +{%- assign prev_major = prev_parts[0] -%} +{%- assign prev_minor = prev_parts[1] -%} + +### Upgrading {{ platform }} to {{ current_version }} + +{%- if x_status == "true" -%} +{%- assign prev_version_label = prev_major | append: "." | append: prev_minor | append: ".x" -%} +{%- else -%} +{%- assign prev_version_label = previous_version -%} +{%- endif -%} + +{% if docsPrefix == "pe/" %} +{%- assign prev_version_label = prev_version_label | append: "PE" -%} +{% endif %} + +{% assign platform_hash = "#upgrading-thingsboard-ce-to-" %} +{% if docsPrefix == "pe/" %} +{%- assign platform_hash = "#upgrading-thingsboard-pe-to-" -%} +{% endif %} + +{%- if use_external_link -%} +{%- assign prev_version_href = "/docs/" | append: docsPrefix | append: "user-guide/install/upgrade-instructions/docker-compose/v" | append: previous_version_path | append: "/" | append: platform_hash | append: previous_version_anchor -%} +{%- else -%} +{%- assign prev_version_href = platform_hash | append: previous_version_anchor -%} +{%- endif -%} + +{% capture difference %} +**NOTE:** +
+These upgrade steps are applicable for ThingsBoard version {{ prev_version_label }}{% if applicable_versions %}{% assign versions = applicable_versions | split: "," %}{% for v in versions %} and ThingsBoard version {{ v | strip }}{% endfor %}{% endif %}. +In order to upgrade to {{ current_version_with_platform | upcase }} you need to [**upgrade to {{ prev_version_label }} first**]({{ prev_version_href }}). +{% endcapture %} +{% include templates/info-banner.md content=difference %} + +{% assign docker-compose-repo-link = "https://github.com/thingsboard/" %} + +{% if docsPrefix == "pe/" %} +{% assign docker-compose-repo-link = docker-compose-repo-link | append: "thingsboard-pe-docker-compose/tree/release-" | append: current_version %} +{% else %} +{% assign docker-compose-repo-link = docker-compose-repo-link | append: "thingsboard/tree/v" | append: current_version | append: "/docker" %} +{% endif %} + +{% capture update_manifests_note %} +We strongly recommend that you also update your Docker Compose deployment manifests to [**the corresponding version from GitHub repository**]({{ docker-compose-repo-link }}) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. +
+
+If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. +{% endcapture %} +{% include templates/warn-banner.md content=update_manifests_note %} + +#### {{ platform }} service upgrade + +{% assign skipUpgrade = false %} +{% if update_status == "false" %} +{% assign skipUpgrade = true %} +{% endif %} + +{% assign version = version %} +{% if docsPrefix == "pe/" %} +{% assign version = version | append: "PE" %} +{% endif %} + +{% include docs/user-guide/install/docker-compose-upgrade-steps.md version=version skipUpgrade=skipUpgrade %} \ No newline at end of file diff --git a/_includes/upgrade-instructions.liquid b/_includes/upgrade-instructions.liquid index fe2825772a..bdf1f3334a 100644 --- a/_includes/upgrade-instructions.liquid +++ b/_includes/upgrade-instructions.liquid @@ -43,6 +43,8 @@ {% include centos-upgrade-instructions.md version=display_version prev_version=display_prev_version x=data.x update_status=data.upgrade applicable_versions=applicable_versions manual_version_upgrade=data.manual-version-upgrade manual_version_upgrade_label=data.manual-version-upgrade-label %} {% elsif os == "docker" %} {% include docker-upgrade-instructions.md version=display_version prev_version=display_prev_version x=data.x update_status=data.upgrade applicable_versions=applicable_versions %} +{% elsif os == "docker-compose" %} +{% include docker-compose-upgrade-instructions.md version=display_version prev_version=display_prev_version x=data.x update_status=data.upgrade applicable_versions=applicable_versions %} {% endif %} {% endif %} diff --git a/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-0-x.md b/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-0-x.md index a8691a2a98..052b048828 100644 --- a/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-0-x.md +++ b/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-0-x.md @@ -12,68 +12,6 @@ effective-url: '/docs/pe/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard PE to 4.0.2 +{% assign docsPrefix = "pe/" %} -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.xPE and ThingsBoard version 4.0.xPE. In order to upgrade to 4.0.2PE you need to [**upgrade to 3.9.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/#upgrading-thingsboard-pe-to-391). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard PE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.0.2PE" %} - -### Upgrading ThingsBoard PE to 4.0.1 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.xPE and ThingsBoard version 4.0.xPE. In order to upgrade to 4.0.1PE you need to [**upgrade to 3.9.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/#upgrading-thingsboard-pe-to-391). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard PE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.0.1PE" %} - -### Upgrading ThingsBoard PE to 4.0.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.xPE. In order to upgrade to 4.0PE you need to [**upgrade to 3.9.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/#upgrading-thingsboard-pe-to-391). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard PE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.0.0PE" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.0" os="docker-compose" %} diff --git a/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-1-x.md b/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-1-x.md index e07ee01aa1..3c90dc9eb4 100644 --- a/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-1-x.md +++ b/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-1-x.md @@ -12,24 +12,7 @@ effective-url: '/docs/pe/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard PE to 4.1.0 +{% assign docsPrefix = "pe/" %} -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.0.xPE. In order to upgrade to 4.1PE you need to [**upgrade to 4.0.2PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-0-x/#upgrading-thingsboard-pe-to-402). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} +{% include upgrade-instructions.liquid family="4.1" os="docker-compose" %} -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard PE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.1.0PE" %} diff --git a/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-2-x.md b/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-2-x.md index 3d8ddee9e6..85fdaf0806 100644 --- a/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-2-x.md +++ b/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-2-x.md @@ -12,68 +12,6 @@ effective-url: '/docs/pe/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard PE to 4.2.1.1 +{% assign docsPrefix = "pe/" %} -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.1PE. In order to upgrade to 4.2.1.1PE you need to [**upgrade to 4.2.1PE first**](#upgrading-thingsboard-pe-to-421). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the corresponding version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/release-4.2.1.1) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard PE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.2.1.1PE" skipUpgrade="true"%} - -### Upgrading ThingsBoard PE to 4.2.1 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.xPE. In order to upgrade to 4.2.1PE you need to [**upgrade to 4.2PE first**](#upgrading-thingsboard-pe-to-420). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the corresponding version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/release-4.2.1) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard PE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.2.1PE" %} - -### Upgrading ThingsBoard PE to 4.2.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.1.xPE. In order to upgrade to 4.2PE you need to [**upgrade to 4.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-1-x/#upgrading-thingsboard-pe-to-410). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the corresponding version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/release-4.2) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard PE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.2.0PE" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.2" os="docker-compose" %} diff --git a/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-3-x.md b/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-3-x.md index 87a68e2bca..958ff4362d 100644 --- a/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-3-x.md +++ b/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-3-x.md @@ -12,24 +12,6 @@ effective-url: '/docs/pe/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard PE to 4.3.0 +{% assign docsPrefix = "pe/" %} -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.1PE. In order to upgrade to 4.3PE you need to [**upgrade to 4.2.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-2-x/#upgrading-thingsboard-pe-to-421). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the corresponding version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/release-4.3) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard PE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.3.0PE" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.3" os="docker-compose" %} diff --git a/docs/user-guide/install/upgrade-instructions/docker-compose/v4-0-x.md b/docs/user-guide/install/upgrade-instructions/docker-compose/v4-0-x.md index 6fe932a5ea..74445e1337 100644 --- a/docs/user-guide/install/upgrade-instructions/docker-compose/v4-0-x.md +++ b/docs/user-guide/install/upgrade-instructions/docker-compose/v4-0-x.md @@ -12,68 +12,4 @@ effective-url: '/docs/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard CE to 4.0.2 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.x and ThingsBoard version 4.0.x. In order to upgrade to 4.0.2 you need to [**upgrade to 3.9.x first**](/docs/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/#upgrading-thingsboard-ce-to-390). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard/tree/master/docker) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.0.2" %} - -### Upgrading ThingsBoard CE to 4.0.1 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.x. In order to upgrade to 4.0.1 you need to [**upgrade to 3.9.x first**](/docs/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/#upgrading-thingsboard-ce-to-390). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard/tree/master/docker) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.0.1" %} - -### Upgrading ThingsBoard CE to 4.0.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 3.9.x. In order to upgrade to 4.0 you need to [**upgrade to 3.9.x first**](/docs/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/#upgrading-thingsboard-ce-to-390). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard/tree/master/docker) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.0.0" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.0" os="docker-compose" %} diff --git a/docs/user-guide/install/upgrade-instructions/docker-compose/v4-1-x.md b/docs/user-guide/install/upgrade-instructions/docker-compose/v4-1-x.md index 4c98e3de1b..eb509f4ba3 100644 --- a/docs/user-guide/install/upgrade-instructions/docker-compose/v4-1-x.md +++ b/docs/user-guide/install/upgrade-instructions/docker-compose/v4-1-x.md @@ -12,24 +12,4 @@ effective-url: '/docs/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard CE to 4.1.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.0.x. In order to upgrade to 4.1 you need to [**upgrade to 4.0.x first**](/docs/user-guide/install/upgrade-instructions/docker-compose/v4-0-x/#upgrading-thingsboard-ce-to-400). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard/tree/master/docker) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.1.0" %} +{% include upgrade-instructions.liquid family="4.1" os="docker-compose" %} diff --git a/docs/user-guide/install/upgrade-instructions/docker-compose/v4-2-x.md b/docs/user-guide/install/upgrade-instructions/docker-compose/v4-2-x.md index f1794e16b1..7a44466b32 100644 --- a/docs/user-guide/install/upgrade-instructions/docker-compose/v4-2-x.md +++ b/docs/user-guide/install/upgrade-instructions/docker-compose/v4-2-x.md @@ -12,68 +12,4 @@ effective-url: '/docs/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard CE to 4.2.1.1 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.1. In order to upgrade to 4.2.1.1 you need to [**upgrade to 4.2.1 first**](#upgrading-thingsboard-ce-to-421). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the corresponding version from GitHub repository**](https://github.com/thingsboard/thingsboard/tree/v4.2.1.1/docker) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.2.1.1" skipUpgrade="true" %} - -### Upgrading ThingsBoard CE to 4.2.1 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.x. In order to upgrade to 4.2.1 you need to [**upgrade to 4.2.x first**](#upgrading-thingsboard-ce-to-420). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the corresponding version from GitHub repository**](https://github.com/thingsboard/thingsboard/tree/v4.2.1/docker) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.2.1" %} - -### Upgrading ThingsBoard CE to 4.2.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.1.x. In order to upgrade to 4.2 you need to [**upgrade to 4.1.x first**](/docs/user-guide/install/upgrade-instructions/docker-compose/v4-1-x/#upgrading-thingsboard-ce-to-410). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the corresponding version from GitHub repository**](https://github.com/thingsboard/thingsboard/tree/v4.2/docker) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.2.0" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.2" os="docker-compose" %} diff --git a/docs/user-guide/install/upgrade-instructions/docker-compose/v4-3-x.md b/docs/user-guide/install/upgrade-instructions/docker-compose/v4-3-x.md index 6e7b610179..b66a07909e 100644 --- a/docs/user-guide/install/upgrade-instructions/docker-compose/v4-3-x.md +++ b/docs/user-guide/install/upgrade-instructions/docker-compose/v4-3-x.md @@ -12,24 +12,4 @@ effective-url: '/docs/user-guide/install/upgrade-instructions/' * TOC {:toc} -### Upgrading ThingsBoard CE to 4.3.0 - -{% capture difference %} -**NOTE:** -
-These upgrade steps are applicable for ThingsBoard version 4.2.1. In order to upgrade to 4.3 you need to [**upgrade to 4.2.1 first**](/docs/user-guide/install/upgrade-instructions/docker-compose/v4-2-x/#upgrading-thingsboard-ce-to-421). -
-{% endcapture %} -{% include templates/info-banner.md content=difference %} - -{% capture update_manifests_note %} -We strongly recommend that you also update your Docker Compose deployment manifests to [**the corresponding version from GitHub repository**](https://github.com/thingsboard/thingsboard/tree/v4.3/docker) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release. -
-
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files. -{% endcapture %} -{% include templates/warn-banner.md content=update_manifests_note %} - -#### ThingsBoard CE service upgrade - -{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.3.0" %} \ No newline at end of file +{% include upgrade-instructions.liquid family="4.3" os="docker-compose" %} From 082ce4e78d68635756a4a2340f416d7eaeede729 Mon Sep 17 00:00:00 2001 From: d2eight Date: Wed, 28 Jan 2026 16:11:02 +0200 Subject: [PATCH 3/7] script for gen versions --- generate_upgrade_pages.py | 250 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 250 insertions(+) create mode 100644 generate_upgrade_pages.py diff --git a/generate_upgrade_pages.py b/generate_upgrade_pages.py new file mode 100644 index 0000000000..5f4e54e85b --- /dev/null +++ b/generate_upgrade_pages.py @@ -0,0 +1,250 @@ + +from __future__ import annotations + +import re +import sys +from pathlib import Path +from typing import List, Tuple + + +DATA_FILE = Path("_data/upgrade-instructions-data.yml") + +SYSTEMS = [ + ("centos", "CentOS"), + ("ubuntu", "Ubuntu"), + ("docker", "Docker"), + ("docker-compose", "Docker Compose"), + ("windows", "Windows"), +] + +CE_BASE = Path("docs/user-guide/install/upgrade-instructions") +PE_BASE = Path("docs/pe/user-guide/install/upgrade-instructions") + +CE_EFFECTIVE_URL = "/docs/user-guide/install/upgrade-instructions/" +PE_EFFECTIVE_URL = "/docs/pe/user-guide/install/upgrade-instructions/" + +CE_LAYOUT = "docwithnav" +PE_LAYOUT = "docwithnav-pe" + +OVERWRITE_MD = False + +LTS_QUOTES = '"' +UPGRADABLE_FROM_QUOTES = '"' +UPGRADE_QUOTES = '"' +X_QUOTES = '"' + +SEMVER_RE = re.compile(r"^\d+(?:\.\d+)*$") +TOP_KEY_RE = re.compile(r"^(\d+(?:\.\d+)*):\s*$") + + +def ask(prompt: str) -> str: + return input(prompt).strip() + + +def ask_bool(prompt: str) -> bool: + while True: + raw = input(prompt).strip().lower() + if raw in ("true", "t", "yes", "y", "1"): + return True + if raw in ("false", "f", "no", "n", "0"): + return False + print("Please answer true/false (or yes/no, 1/0).") + + +def validate_version_string(v: str) -> None: + if not SEMVER_RE.match(v): + raise ValueError("Version must be digits separated by dots, e.g. 4.2.1.1") + + +def parse_version_to_tuple(v: str) -> Tuple[int, ...]: + parts = [int(p) for p in v.split(".")] + if len(parts) == 2: + parts.append(0) + return tuple(parts) + + +def is_version_greater(a: str, b: str) -> bool: + ta = parse_version_to_tuple(a) + tb = parse_version_to_tuple(b) + max_len = max(len(ta), len(tb)) + pa = ta + (-1,) * (max_len - len(ta)) + pb = tb + (-1,) * (max_len - len(tb)) + return pa > pb + + +def family_of(version: str) -> str: + parts = version.split(".") + if len(parts) < 2: + raise ValueError("Version must have at least major.minor, e.g. 4.2.0") + return f"{parts[0]}.{parts[1]}" + + +def family_exists(existing_versions: List[str], fam: str) -> bool: + pref = fam + "." + return any(v == fam or v.startswith(pref) for v in existing_versions) + + +def md_filename_for_family(fam: str) -> str: + major, minor = fam.split(".", 1) + return f"v{major}-{minor}-x.md" + + +def render_md_ce(fam: str, os_key: str, os_title: str) -> str: + return f"""--- +layout: {CE_LAYOUT} +title: ThingsBoard CE v{fam}.x upgrade instructions for {os_title} +description: ThingsBoard CE v{fam}.x upgrade guide for {os_title} +active-menu-item-click: "true" +breadcrumbs: true +breadcrumbs-steps: 2 +breadcrumbs-show: 2 +effective-url: '{CE_EFFECTIVE_URL}' +--- + +* TOC +{{:toc}} + +{{% include upgrade-instructions.liquid family="{fam}" os="{os_key}" %}} +""" + + +def render_md_pe(fam: str, os_key: str, os_title: str) -> str: + return f"""--- +layout: {PE_LAYOUT} +title: ThingsBoard PE v{fam}.x upgrade instructions for {os_title} +description: ThingsBoard PE v{fam}.x upgrade guide for {os_title} +active-menu-item-click: "true" +breadcrumbs: true +breadcrumbs-steps: 2 +breadcrumbs-show: 2 +effective-url: '{PE_EFFECTIVE_URL}' +--- + +* TOC +{{:toc}} + +{{% assign docsPrefix = "pe/" %}} + +{{% include upgrade-instructions.liquid family="{fam}" os="{os_key}" %}} +""" + + +def write_file(path: Path, content: str) -> None: + path.parent.mkdir(parents=True, exist_ok=True) + if path.exists() and not OVERWRITE_MD: + print(f"SKIP (exists): {path}") + return + path.write_text(content, encoding="utf-8") + print(f"WROTE: {path}") + + +def build_new_version_block( + new_version: str, + upgradable_from: str, + release_date: str, + is_lts: bool, + upgrade: bool, +) -> str: + lts_val = "true" if is_lts else "false" + upgrade_val = "true" if upgrade else "false" + + return ( + f"{new_version}:\n" + f" upgradable-from: {UPGRADABLE_FROM_QUOTES}{upgradable_from}{UPGRADABLE_FROM_QUOTES}\n" + f" release-date: {release_date}\n" + f" lts: {LTS_QUOTES}{lts_val}{LTS_QUOTES}\n" + f" upgrade: {UPGRADE_QUOTES}{upgrade_val}{UPGRADE_QUOTES}\n" + f" x: \"true\"\n" + ) + + +def extract_versions_with_line_indexes(lines: List[str]) -> List[Tuple[str, int]]: + out: List[Tuple[str, int]] = [] + for i, line in enumerate(lines): + m = TOP_KEY_RE.match(line.rstrip("\n")) + if m: + out.append((m.group(1), i)) + return out + + +def main() -> int: + print("=== Upgrade instructions generator ===") + + new_version = ask("1) New version name: ") + try: + validate_version_string(new_version) + except Exception as e: + print(f"ERROR: {e}") + return 2 + + release_date = ask(f"2) {new_version} release date: ") + is_lts = ask_bool(f"3) Is {new_version} lts version (true/false): ") + upgradable_from = ask(f"4) {new_version} upgradable-from: ") + upgrade = ask_bool(f"5) {new_version} upgrade (true/false): ") + + if not DATA_FILE.exists(): + print(f"ERROR: {DATA_FILE} not found") + return 2 + + raw = DATA_FILE.read_text(encoding="utf-8") + lines = raw.splitlines(keepends=True) + + versions_with_idx = extract_versions_with_line_indexes(lines) + existing_versions = [v for v, _ in versions_with_idx] + + if new_version in existing_versions: + print(f"ERROR: Version {new_version} already exists in {DATA_FILE}. Nothing changed.") + return 2 + + insert_at = None + for v, idx in versions_with_idx: + try: + if is_version_greater(new_version, v): + insert_at = idx + break + except Exception: + continue + + new_block = build_new_version_block( + new_version=new_version, + upgradable_from=upgradable_from, + release_date=release_date, + is_lts=is_lts, + upgrade=upgrade, + ) + + if insert_at is None: + if lines and not lines[-1].endswith("\n"): + lines[-1] += "\n" + lines.append(new_block) + print(f"Added new version to YAML (appended): {new_version}") + else: + lines.insert(insert_at, new_block) + print(f"Added new version to YAML (inserted): {new_version}") + + DATA_FILE.write_text("".join(lines), encoding="utf-8") + print(f"WROTE: {DATA_FILE}") + + fam = family_of(new_version) + is_new_family = not family_exists(existing_versions, fam) + + if not is_new_family: + print(f"Family {fam} already exists -> no new md files created.") + return 0 + + print(f"New family detected: {fam} -> generating md files...") + + filename = md_filename_for_family(fam) + for os_key, os_title in SYSTEMS: + ce_path = CE_BASE / os_key / filename + pe_path = PE_BASE / os_key / filename + + write_file(ce_path, render_md_ce(fam, os_key, os_title)) + write_file(pe_path, render_md_pe(fam, os_key, os_title)) + + print("Done.") + return 0 + + +if __name__ == "__main__": + raise SystemExit(main()) From e8a205c73a012498a45fdf19966a123cf5f6c748 Mon Sep 17 00:00:00 2001 From: d2eight Date: Wed, 28 Jan 2026 21:02:54 +0200 Subject: [PATCH 4/7] version generator script --- generate_new_version.py | 633 ++++++++++++++++++++++++++++++++++++++ generate_upgrade_pages.py | 250 --------------- 2 files changed, 633 insertions(+), 250 deletions(-) create mode 100644 generate_new_version.py delete mode 100644 generate_upgrade_pages.py diff --git a/generate_new_version.py b/generate_new_version.py new file mode 100644 index 0000000000..8de7ce0803 --- /dev/null +++ b/generate_new_version.py @@ -0,0 +1,633 @@ +from __future__ import annotations + +import re +from datetime import datetime +from pathlib import Path +from typing import List, Tuple, Optional + +DATA_FILE = Path("_data/upgrade-instructions-data.yml") + +SYSTEMS = [ + ("centos", "CentOS"), + ("ubuntu", "Ubuntu"), + ("docker", "Docker"), + ("docker-compose", "Docker Compose"), + ("windows", "Windows"), +] + +CE_UPG_BASE = Path("docs/user-guide/install/upgrade-instructions") +PE_UPG_BASE = Path("docs/pe/user-guide/install/upgrade-instructions") + +CE_UPG_EFFECTIVE_URL = "/docs/user-guide/install/upgrade-instructions/" +PE_UPG_EFFECTIVE_URL = "/docs/pe/user-guide/install/upgrade-instructions/" + +CE_UPG_LAYOUT = "docwithnav" +PE_UPG_LAYOUT = "docwithnav-pe" + +CE_REL_FAMILY_DIR = Path("docs/releases/releases-table") +PE_REL_FAMILY_DIR = Path("docs/pe/releases/releases-table") + +CE_REL_INCLUDES_DIR = Path("_includes/docs/releases/releases-table") +PE_REL_INCLUDES_DIR = Path("_includes/docs/pe/releases/releases-table") + +CE_REL_EFFECTIVE_URL = "/docs/releases/releases-table/" +PE_REL_EFFECTIVE_URL = "/docs/pe/releases/releases-table/" + +CE_REL_LAYOUT = "docwithnav" +PE_REL_LAYOUT = "docwithnav-pe" + +OVERWRITE_UPGRADE_MD = False +OVERWRITE_RELEASE_INCLUDES = False +OVERWRITE_RELEASE_FAMILY_FILES = False + +UPGRADABLE_FROM_QUOTES = '"' +BOOL_QUOTES = '"' + + +SEMVER_RE = re.compile(r"^\d+(?:\.\d+)*$") +TOP_KEY_RE = re.compile(r"^(\d+(?:\.\d+)*):\s*$") + +CE_REL_INCLUDE_RE = re.compile( + r"^\{\%\s*include\s+docs/releases/releases-table/(v\d+(?:-\d+)*\.md)\s*\%\}\s*$" +) +PE_REL_INCLUDE_RE = re.compile( + r"^\{\%\s*include\s+docs/pe/releases/releases-table/(v\d+(?:-\d+)*\.md)\s*\%\}\s*$" +) + +def ask(prompt: str) -> str: + return input(prompt).strip() + + +def ask_bool(prompt: str) -> bool: + while True: + raw = input(prompt).strip().lower() + if raw in ("true", "t", "yes", "y", "1"): + return True + if raw in ("false", "f", "no", "n", "0"): + return False + print("Please answer true/false (or yes/no, 1/0).") + + +def validate_version_string(v: str) -> None: + if not SEMVER_RE.match(v): + raise ValueError("Version must be digits separated by dots, e.g. 4.2.1.1") + + +def parse_version_to_tuple(v: str) -> Tuple[int, ...]: + parts = [int(p) for p in v.split(".")] + if len(parts) == 2: + parts.append(0) + return tuple(parts) + + +def is_version_greater(a: str, b: str) -> bool: + ta = parse_version_to_tuple(a) + tb = parse_version_to_tuple(b) + max_len = max(len(ta), len(tb)) + pa = ta + (-1,) * (max_len - len(ta)) + pb = tb + (-1,) * (max_len - len(tb)) + return pa > pb + + +def family_of(version: str) -> str: + parts = version.split(".") + if len(parts) < 2: + raise ValueError("Version must have at least major.minor, e.g. 4.2.0") + return f"{parts[0]}.{parts[1]}" + + +def family_exists(existing_versions: List[str], fam: str) -> bool: + pref = fam + "." + return any(v == fam or v.startswith(pref) for v in existing_versions) + + +def md_filename_for_family(fam: str) -> str: + major, minor = fam.split(".", 1) + return f"v{major}-{minor}-x.md" + + +def md_filename_for_version_full(version: str) -> str: + return "v" + "-".join(version.split(".")) + ".md" + + +def sort_versions_desc(versions: List[str]) -> List[str]: + uniq = list(dict.fromkeys(versions)) + uniq.sort(key=parse_version_to_tuple, reverse=True) + return uniq + + +DATE_FORMATS = [ + "%d %b %Y", + "%d %B %Y", + "%b %d %Y", + "%B %d %Y", + "%b %d, %Y", + "%B %d, %Y", + "%d %b, %Y", + "%d %B, %Y", +] + +def parse_user_date(s: str) -> Optional[datetime]: + s = s.strip() + for fmt in DATE_FORMATS: + try: + return datetime.strptime(s, fmt) + except ValueError: + continue + return None + + +def fmt_last_updated(dt: datetime) -> str: + return dt.strftime("%b %d, %Y").replace(" 0", " ") + + +def fmt_latest_patch_date(dt: datetime) -> str: + return fmt_last_updated(dt) + + +def fmt_release_date_frontmatter(dt: datetime) -> str: + return fmt_last_updated(dt) + + +def fmt_release_date_for_includes(dt: datetime) -> str: + return dt.strftime("%b %d, %Y").replace(" 0", " ") + + +def extract_versions_with_line_indexes(lines: List[str]) -> List[Tuple[str, int]]: + out: List[Tuple[str, int]] = [] + for i, line in enumerate(lines): + m = TOP_KEY_RE.match(line.rstrip("\n")) + if m: + out.append((m.group(1), i)) + return out + + +def write_file(path: Path, content: str, overwrite: bool) -> None: + path.parent.mkdir(parents=True, exist_ok=True) + if path.exists() and not overwrite: + print(f"SKIP (exists): {path}") + return + path.write_text(content, encoding="utf-8") + print(f"WROTE: {path}") + +def extract_frontmatter(text: str) -> Tuple[str, str, str]: + if not text.startswith("---"): + return "", "", text + parts = text.split("---", 2) + if len(parts) < 3: + return "", "", text + fm_body = parts[1] + rest = parts[2] + fm_full = "---" + fm_body + "---" + return fm_full, fm_body, rest + + +def replace_frontmatter_lines_keep_everything_else(text: str, replacements: dict) -> str: + fm_full, fm_body, rest = extract_frontmatter(text) + if not fm_full: + return text + + fm_lines = fm_body.splitlines(True) + new_lines = [] + for line in fm_lines: + stripped = line.strip() + key = stripped.split(":", 1)[0] if ":" in stripped else "" + if key in replacements: + new_lines.append(replacements[key] + "\n") + else: + new_lines.append(line) + + new_fm_full = "---\n" + "".join(new_lines).lstrip("\n") + "---" + return new_fm_full + rest + + +def upsert_frontmatter_key(text: str, key: str, value_line: str) -> str: + if not text.startswith("---"): + return text + + parts = text.split("---", 2) + if len(parts) < 3: + return text + + fm_body = parts[1] + rest = parts[2] + fm_lines = fm_body.splitlines(True) + + key_re = re.compile(rf"^\s*{re.escape(key)}\s*:\s*.*$") + + for i, line in enumerate(fm_lines): + if key_re.match(line.strip()): + fm_lines[i] = value_line + "\n" + new_fm = "---\n" + "".join(fm_lines).lstrip("\n") + "---" + return new_fm + rest + + # insert if missing + insert_after = None + for i, line in enumerate(fm_lines): + if line.strip().startswith("breadcrumbs-steps:"): + insert_after = i + break + + if insert_after is None: + fm_lines.append(value_line + "\n") + else: + fm_lines.insert(insert_after + 1, value_line + "\n") + + new_fm = "---\n" + "".join(fm_lines).lstrip("\n") + "---" + return new_fm + rest + + +def render_upgrade_md_ce(fam: str, os_key: str, os_title: str) -> str: + return f"""--- +layout: {CE_UPG_LAYOUT} +title: ThingsBoard CE v{fam}.x upgrade instructions for {os_title} +description: ThingsBoard CE v{fam}.x upgrade guide for {os_title} +active-menu-item-click: "true" +breadcrumbs: true +breadcrumbs-steps: 2 +breadcrumbs-show: 2 +effective-url: '{CE_UPG_EFFECTIVE_URL}' +--- + +* TOC +{{{{:toc}}}} + +{{{{% include upgrade-instructions.liquid family="{fam}" os="{os_key}" %}}}} +""" + + +def render_upgrade_md_pe(fam: str, os_key: str, os_title: str) -> str: + return f"""--- +layout: {PE_UPG_LAYOUT} +title: ThingsBoard PE v{fam}.x upgrade instructions for {os_title} +description: ThingsBoard PE v{fam}.x upgrade guide for {os_title} +active-menu-item-click: "true" +breadcrumbs: true +breadcrumbs-steps: 2 +breadcrumbs-show: 2 +effective-url: '{PE_UPG_EFFECTIVE_URL}' +--- + +* TOC +{{{{:toc}}}} + +{{{{% assign docsPrefix = "pe/" %}}}} + +{{{{% include upgrade-instructions.liquid family="{fam}" os="{os_key}" %}}}} +""" + + +def render_release_include_ce(version: str, release_dt: datetime) -> str: + date_str = fmt_release_date_for_includes(release_dt) + return f"### ThingsBoard CE v{version} ({date_str})\n" + + +def render_release_include_pe(version: str, release_dt: datetime) -> str: + date_str = fmt_release_date_for_includes(release_dt) + return f"### ThingsBoard PE v{version} ({date_str})\n" + + +def render_release_family_ce( + fam: str, + release_date_dt: Optional[datetime], + latest_patch_version: str, + latest_patch_dt: Optional[datetime], + release_note_label: str, + lts_true: bool, +) -> str: + release_date_str = fmt_release_date_frontmatter(release_date_dt) if release_date_dt else "TBD" + last_updated_str = fmt_last_updated(latest_patch_dt) if latest_patch_dt else release_date_str + latest_patch_str = f"v{latest_patch_version} ({fmt_latest_patch_date(latest_patch_dt)})" if latest_patch_dt else f"v{latest_patch_version}" + lts_line = "lts: 'true'\n" if lts_true else "" + + return f"""--- +layout: {CE_REL_LAYOUT} +title: Thingsboard v{fam}.x release notes +description: Discover Thingsboard v{fam}.x release notes +breadcrumbs: 'true' +breadcrumbs-steps: '1' +{lts_line}release-date: {release_date_str} +last-updated: {last_updated_str} +release-note-label: {release_note_label} +active-menu-item-click: 'true' +latest-patch: {latest_patch_str} +effective-url: '{CE_REL_EFFECTIVE_URL}' +--- +* TOC +{{{{:toc}}}} + +""" + + +def render_release_family_pe( + fam: str, + release_date_dt: Optional[datetime], + latest_patch_version: str, + latest_patch_dt: Optional[datetime], + release_note_label: str, + lts_true: bool, +) -> str: + release_date_str = fmt_release_date_frontmatter(release_date_dt) if release_date_dt else "TBD" + last_updated_str = fmt_last_updated(latest_patch_dt) if latest_patch_dt else release_date_str + latest_patch_str = f"v{latest_patch_version} ({fmt_latest_patch_date(latest_patch_dt)})" if latest_patch_dt else f"v{latest_patch_version}" + lts_line = "lts: 'true'\n" if lts_true else "" + + return f"""--- +layout: {PE_REL_LAYOUT} +title: Thingsboard PE v{fam}.x release notes +description: Discover Thingsboard PE v{fam}.x release notes +breadcrumbs: 'true' +breadcrumbs-steps: '1' +{lts_line}release-date: {release_date_str} +last-updated: {last_updated_str} +release-note-label: {release_note_label} +active-menu-item-click: 'true' +latest-patch: {latest_patch_str} +effective-url: '{PE_REL_EFFECTIVE_URL}' +--- +* TOC +{{{{:toc}}}} + +{{{{% assign docsPrefix = "pe/" %}}}} + +""" + + +def get_included_versions_from_family(lines: List[str], is_pe: bool) -> List[str]: + out: List[str] = [] + inc_re = PE_REL_INCLUDE_RE if is_pe else CE_REL_INCLUDE_RE + for line in lines: + m = inc_re.match(line.strip()) + if not m: + continue + fname = m.group(1) # v4-2-1-1-0-1.md + mm = re.match(r"^v(\d+(?:-\d+)*)\.md$", fname) + if mm: + out.append(mm.group(1).replace("-", ".")) + return out + + +def build_include_line_for_version(version: str, is_pe: bool) -> str: + fname = md_filename_for_version_full(version) + if is_pe: + return f"{{% include docs/pe/releases/releases-table/{fname} %}}" + return f"{{% include docs/releases/releases-table/{fname} %}}" + + +def update_or_insert_release_family_includes(family_path: Path, version: str, is_pe: bool) -> None: + text = family_path.read_text(encoding="utf-8") + lines = text.splitlines(True) + + existing = get_included_versions_from_family(lines, is_pe=is_pe) + + fam = family_of(version) + fam_prefix = fam + "." + existing_same_fam = [v for v in existing if v.startswith(fam_prefix)] + + merged = sort_versions_desc(existing_same_fam + [version]) + include_lines = [build_include_line_for_version(v, is_pe=is_pe) + "\n" for v in merged] + + inc_re = PE_REL_INCLUDE_RE if is_pe else CE_REL_INCLUDE_RE + + start = None + end = None + for i, line in enumerate(lines): + if inc_re.match(line.strip()): + if start is None: + start = i + end = i + else: + if start is not None: + break + + if start is not None and end is not None: + new_lines = lines[:start] + include_lines + lines[end + 1:] + else: + if lines and not lines[-1].endswith("\n"): + lines[-1] += "\n" + if lines and lines[-1].strip() != "": + lines.append("\n") + new_lines = lines + include_lines + + family_path.write_text("".join(new_lines), encoding="utf-8") + print(f"UPDATED includes in: {family_path}") + + +def get_latest_included_version_from_family(family_path: Path, is_pe: bool) -> Optional[str]: + if not family_path.exists(): + return None + lines = family_path.read_text(encoding="utf-8").splitlines() + versions = get_included_versions_from_family(lines, is_pe=is_pe) + if not versions: + return None + versions = sort_versions_desc(versions) + return versions[0] + + +def ensure_release_family_file( + fam: str, + ce_family_path: Path, + pe_family_path: Path, + new_version: str, + release_date_dt: Optional[datetime], + release_note_label_ce: str, + release_note_label_pe: str, + lts_true: bool, +) -> None: + if not ce_family_path.exists(): + base = render_release_family_ce( + fam=fam, + release_date_dt=release_date_dt, + latest_patch_version=new_version, + latest_patch_dt=release_date_dt, + release_note_label=release_note_label_ce, + lts_true=lts_true, + ) + write_file(ce_family_path, base, overwrite=OVERWRITE_RELEASE_FAMILY_FILES) + + if not pe_family_path.exists(): + base = render_release_family_pe( + fam=fam, + release_date_dt=release_date_dt, + latest_patch_version=new_version, + latest_patch_dt=release_date_dt, + release_note_label=release_note_label_pe, + lts_true=lts_true, + ) + write_file(pe_family_path, base, overwrite=OVERWRITE_RELEASE_FAMILY_FILES) + +def build_new_version_block( + new_version: str, + upgradable_from: str, + release_date_raw: str, + is_lts: bool, + upgrade: bool, +) -> str: + lts_val = "true" if is_lts else "false" + upgrade_val = "true" if upgrade else "false" + + return ( + f"{new_version}:\n" + f" upgradable-from: {UPGRADABLE_FROM_QUOTES}{upgradable_from}{UPGRADABLE_FROM_QUOTES}\n" + f" release-date: {release_date_raw}\n" + f" lts: {BOOL_QUOTES}{lts_val}{BOOL_QUOTES}\n" + f" upgrade: {BOOL_QUOTES}{upgrade_val}{BOOL_QUOTES}\n" + f" x: {BOOL_QUOTES}true{BOOL_QUOTES}\n" + ) + +def main() -> int: + print("=== Upgrade instructions generator ===") + + new_version = ask("1) New version name: ") + try: + validate_version_string(new_version) + except Exception as e: + print(f"ERROR: {e}") + return 2 + + release_date_raw = ask(f"2) {new_version} release date: ") + release_dt = parse_user_date(release_date_raw) + if release_dt is None: + print("ERROR: Can't parse release date. Examples: '28 Jan 2026', 'Jan 28 2026', 'Jan 28, 2026'") + return 2 + + is_lts = ask_bool(f"3) Is {new_version} lts version (true/false): ") + upgradable_from = ask(f"4) {new_version} upgradable-from: ") + upgrade = ask_bool(f"5) {new_version} upgrade (true/false): ") + + if not DATA_FILE.exists(): + print(f"ERROR: {DATA_FILE} not found") + return 2 + + yml_text = DATA_FILE.read_text(encoding="utf-8") + yml_lines = yml_text.splitlines(keepends=True) + + versions_with_idx = extract_versions_with_line_indexes(yml_lines) + existing_versions = [v for v, _ in versions_with_idx] + + if new_version in existing_versions: + print(f"ERROR: Version {new_version} already exists in {DATA_FILE}. Nothing changed.") + return 2 + + insert_at = None + for v, idx in versions_with_idx: + try: + if is_version_greater(new_version, v): + insert_at = idx + break + except Exception: + continue + + new_block = build_new_version_block( + new_version=new_version, + upgradable_from=upgradable_from, + release_date_raw=release_date_raw, + is_lts=is_lts, + upgrade=upgrade, + ) + + if insert_at is None: + if yml_lines and not yml_lines[-1].endswith("\n"): + yml_lines[-1] += "\n" + yml_lines.append(new_block) + print(f"Added new version to YAML (appended): {new_version}") + else: + yml_lines.insert(insert_at, new_block) + print(f"Added new version to YAML (inserted): {new_version}") + + DATA_FILE.write_text("".join(yml_lines), encoding="utf-8") + print(f"WROTE: {DATA_FILE}") + + fam = family_of(new_version) + is_new_family = not family_exists(existing_versions, fam) + + if is_new_family: + print(f"New upgrade-instructions family detected: {fam} -> generating md files...") + fname = md_filename_for_family(fam) + for os_key, os_title in SYSTEMS: + ce_path = CE_UPG_BASE / os_key / fname + pe_path = PE_UPG_BASE / os_key / fname + write_file(ce_path, render_upgrade_md_ce(fam, os_key, os_title), overwrite=OVERWRITE_UPGRADE_MD) + write_file(pe_path, render_upgrade_md_pe(fam, os_key, os_title), overwrite=OVERWRITE_UPGRADE_MD) + else: + print(f"Upgrade-instructions family {fam} already exists -> no new upgrade md files created.") + + ver_fname = md_filename_for_version_full(new_version) + ce_inc_path = CE_REL_INCLUDES_DIR / ver_fname + pe_inc_path = PE_REL_INCLUDES_DIR / ver_fname + + write_file(ce_inc_path, render_release_include_ce(new_version, release_dt), overwrite=OVERWRITE_RELEASE_INCLUDES) + write_file(pe_inc_path, render_release_include_pe(new_version, release_dt), overwrite=OVERWRITE_RELEASE_INCLUDES) + + ce_family_path = CE_REL_FAMILY_DIR / md_filename_for_family(fam) + pe_family_path = PE_REL_FAMILY_DIR / md_filename_for_family(fam) + + release_family_is_new = (not ce_family_path.exists()) and (not pe_family_path.exists()) + + release_note_label_ce = "TBD" + release_note_label_pe = "TBD" + + if release_family_is_new: + release_note_label_ce = ask(f"6) Release note label for CE v{fam}.x: ") + same_for_pe = ask_bool("7) Is the same release-note-label for PE? (true/false): ") + if same_for_pe: + release_note_label_pe = release_note_label_ce + else: + release_note_label_pe = ask(f"8) Release note label for PE v{fam}.x: ") + + ensure_release_family_file( + fam=fam, + ce_family_path=ce_family_path, + pe_family_path=pe_family_path, + new_version=new_version, + release_date_dt=release_dt, + release_note_label_ce=release_note_label_ce, + release_note_label_pe=release_note_label_pe, + lts_true=is_lts, + ) + + update_or_insert_release_family_includes(ce_family_path, new_version, is_pe=False) + update_or_insert_release_family_includes(pe_family_path, new_version, is_pe=True) + + latest_ce = get_latest_included_version_from_family(ce_family_path, is_pe=False) + latest_pe = get_latest_included_version_from_family(pe_family_path, is_pe=True) + + if latest_ce == new_version: + rep = { + "latest-patch": f"latest-patch: v{new_version} ({fmt_latest_patch_date(release_dt)})", + "last-updated": f"last-updated: {fmt_last_updated(release_dt)}", + } + ce_text = ce_family_path.read_text(encoding="utf-8") + ce_family_path.write_text(replace_frontmatter_lines_keep_everything_else(ce_text, rep), encoding="utf-8") + print(f"UPDATED frontmatter latest-patch/last-updated in: {ce_family_path}") + + if latest_pe == new_version: + rep = { + "latest-patch": f"latest-patch: v{new_version} ({fmt_latest_patch_date(release_dt)})", + "last-updated": f"last-updated: {fmt_last_updated(release_dt)}", + } + pe_text = pe_family_path.read_text(encoding="utf-8") + pe_family_path.write_text(replace_frontmatter_lines_keep_everything_else(pe_text, rep), encoding="utf-8") + print(f"UPDATED frontmatter latest-patch/last-updated in: {pe_family_path}") + + if is_lts: + ce_text = ce_family_path.read_text(encoding="utf-8") + pe_text = pe_family_path.read_text(encoding="utf-8") + + ce_new = upsert_frontmatter_key(ce_text, "lts", "lts: 'true'") + pe_new = upsert_frontmatter_key(pe_text, "lts", "lts: 'true'") + + if ce_new != ce_text: + ce_family_path.write_text(ce_new, encoding="utf-8") + print(f"UPDATED frontmatter lts in: {ce_family_path}") + + if pe_new != pe_text: + pe_family_path.write_text(pe_new, encoding="utf-8") + print(f"UPDATED frontmatter lts in: {pe_family_path}") + + print("Done.") + return 0 + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/generate_upgrade_pages.py b/generate_upgrade_pages.py deleted file mode 100644 index 5f4e54e85b..0000000000 --- a/generate_upgrade_pages.py +++ /dev/null @@ -1,250 +0,0 @@ - -from __future__ import annotations - -import re -import sys -from pathlib import Path -from typing import List, Tuple - - -DATA_FILE = Path("_data/upgrade-instructions-data.yml") - -SYSTEMS = [ - ("centos", "CentOS"), - ("ubuntu", "Ubuntu"), - ("docker", "Docker"), - ("docker-compose", "Docker Compose"), - ("windows", "Windows"), -] - -CE_BASE = Path("docs/user-guide/install/upgrade-instructions") -PE_BASE = Path("docs/pe/user-guide/install/upgrade-instructions") - -CE_EFFECTIVE_URL = "/docs/user-guide/install/upgrade-instructions/" -PE_EFFECTIVE_URL = "/docs/pe/user-guide/install/upgrade-instructions/" - -CE_LAYOUT = "docwithnav" -PE_LAYOUT = "docwithnav-pe" - -OVERWRITE_MD = False - -LTS_QUOTES = '"' -UPGRADABLE_FROM_QUOTES = '"' -UPGRADE_QUOTES = '"' -X_QUOTES = '"' - -SEMVER_RE = re.compile(r"^\d+(?:\.\d+)*$") -TOP_KEY_RE = re.compile(r"^(\d+(?:\.\d+)*):\s*$") - - -def ask(prompt: str) -> str: - return input(prompt).strip() - - -def ask_bool(prompt: str) -> bool: - while True: - raw = input(prompt).strip().lower() - if raw in ("true", "t", "yes", "y", "1"): - return True - if raw in ("false", "f", "no", "n", "0"): - return False - print("Please answer true/false (or yes/no, 1/0).") - - -def validate_version_string(v: str) -> None: - if not SEMVER_RE.match(v): - raise ValueError("Version must be digits separated by dots, e.g. 4.2.1.1") - - -def parse_version_to_tuple(v: str) -> Tuple[int, ...]: - parts = [int(p) for p in v.split(".")] - if len(parts) == 2: - parts.append(0) - return tuple(parts) - - -def is_version_greater(a: str, b: str) -> bool: - ta = parse_version_to_tuple(a) - tb = parse_version_to_tuple(b) - max_len = max(len(ta), len(tb)) - pa = ta + (-1,) * (max_len - len(ta)) - pb = tb + (-1,) * (max_len - len(tb)) - return pa > pb - - -def family_of(version: str) -> str: - parts = version.split(".") - if len(parts) < 2: - raise ValueError("Version must have at least major.minor, e.g. 4.2.0") - return f"{parts[0]}.{parts[1]}" - - -def family_exists(existing_versions: List[str], fam: str) -> bool: - pref = fam + "." - return any(v == fam or v.startswith(pref) for v in existing_versions) - - -def md_filename_for_family(fam: str) -> str: - major, minor = fam.split(".", 1) - return f"v{major}-{minor}-x.md" - - -def render_md_ce(fam: str, os_key: str, os_title: str) -> str: - return f"""--- -layout: {CE_LAYOUT} -title: ThingsBoard CE v{fam}.x upgrade instructions for {os_title} -description: ThingsBoard CE v{fam}.x upgrade guide for {os_title} -active-menu-item-click: "true" -breadcrumbs: true -breadcrumbs-steps: 2 -breadcrumbs-show: 2 -effective-url: '{CE_EFFECTIVE_URL}' ---- - -* TOC -{{:toc}} - -{{% include upgrade-instructions.liquid family="{fam}" os="{os_key}" %}} -""" - - -def render_md_pe(fam: str, os_key: str, os_title: str) -> str: - return f"""--- -layout: {PE_LAYOUT} -title: ThingsBoard PE v{fam}.x upgrade instructions for {os_title} -description: ThingsBoard PE v{fam}.x upgrade guide for {os_title} -active-menu-item-click: "true" -breadcrumbs: true -breadcrumbs-steps: 2 -breadcrumbs-show: 2 -effective-url: '{PE_EFFECTIVE_URL}' ---- - -* TOC -{{:toc}} - -{{% assign docsPrefix = "pe/" %}} - -{{% include upgrade-instructions.liquid family="{fam}" os="{os_key}" %}} -""" - - -def write_file(path: Path, content: str) -> None: - path.parent.mkdir(parents=True, exist_ok=True) - if path.exists() and not OVERWRITE_MD: - print(f"SKIP (exists): {path}") - return - path.write_text(content, encoding="utf-8") - print(f"WROTE: {path}") - - -def build_new_version_block( - new_version: str, - upgradable_from: str, - release_date: str, - is_lts: bool, - upgrade: bool, -) -> str: - lts_val = "true" if is_lts else "false" - upgrade_val = "true" if upgrade else "false" - - return ( - f"{new_version}:\n" - f" upgradable-from: {UPGRADABLE_FROM_QUOTES}{upgradable_from}{UPGRADABLE_FROM_QUOTES}\n" - f" release-date: {release_date}\n" - f" lts: {LTS_QUOTES}{lts_val}{LTS_QUOTES}\n" - f" upgrade: {UPGRADE_QUOTES}{upgrade_val}{UPGRADE_QUOTES}\n" - f" x: \"true\"\n" - ) - - -def extract_versions_with_line_indexes(lines: List[str]) -> List[Tuple[str, int]]: - out: List[Tuple[str, int]] = [] - for i, line in enumerate(lines): - m = TOP_KEY_RE.match(line.rstrip("\n")) - if m: - out.append((m.group(1), i)) - return out - - -def main() -> int: - print("=== Upgrade instructions generator ===") - - new_version = ask("1) New version name: ") - try: - validate_version_string(new_version) - except Exception as e: - print(f"ERROR: {e}") - return 2 - - release_date = ask(f"2) {new_version} release date: ") - is_lts = ask_bool(f"3) Is {new_version} lts version (true/false): ") - upgradable_from = ask(f"4) {new_version} upgradable-from: ") - upgrade = ask_bool(f"5) {new_version} upgrade (true/false): ") - - if not DATA_FILE.exists(): - print(f"ERROR: {DATA_FILE} not found") - return 2 - - raw = DATA_FILE.read_text(encoding="utf-8") - lines = raw.splitlines(keepends=True) - - versions_with_idx = extract_versions_with_line_indexes(lines) - existing_versions = [v for v, _ in versions_with_idx] - - if new_version in existing_versions: - print(f"ERROR: Version {new_version} already exists in {DATA_FILE}. Nothing changed.") - return 2 - - insert_at = None - for v, idx in versions_with_idx: - try: - if is_version_greater(new_version, v): - insert_at = idx - break - except Exception: - continue - - new_block = build_new_version_block( - new_version=new_version, - upgradable_from=upgradable_from, - release_date=release_date, - is_lts=is_lts, - upgrade=upgrade, - ) - - if insert_at is None: - if lines and not lines[-1].endswith("\n"): - lines[-1] += "\n" - lines.append(new_block) - print(f"Added new version to YAML (appended): {new_version}") - else: - lines.insert(insert_at, new_block) - print(f"Added new version to YAML (inserted): {new_version}") - - DATA_FILE.write_text("".join(lines), encoding="utf-8") - print(f"WROTE: {DATA_FILE}") - - fam = family_of(new_version) - is_new_family = not family_exists(existing_versions, fam) - - if not is_new_family: - print(f"Family {fam} already exists -> no new md files created.") - return 0 - - print(f"New family detected: {fam} -> generating md files...") - - filename = md_filename_for_family(fam) - for os_key, os_title in SYSTEMS: - ce_path = CE_BASE / os_key / filename - pe_path = PE_BASE / os_key / filename - - write_file(ce_path, render_md_ce(fam, os_key, os_title)) - write_file(pe_path, render_md_pe(fam, os_key, os_title)) - - print("Done.") - return 0 - - -if __name__ == "__main__": - raise SystemExit(main()) From 9ac5208a901badfb7a0071bdbffa6ffb1c1c4ab6 Mon Sep 17 00:00:00 2001 From: d2eight Date: Wed, 28 Jan 2026 21:25:56 +0200 Subject: [PATCH 5/7] Maintenance LTS --- _includes/releases-table.liquid | 15 ++++++++++++--- _includes/releases-table.sass | 2 +- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/_includes/releases-table.liquid b/_includes/releases-table.liquid index bc78b5e597..0658000401 100644 --- a/_includes/releases-table.liquid +++ b/_includes/releases-table.liquid @@ -16,6 +16,7 @@
+ {% assign active_lts_already_set = false %} {% for page in releases %} {% if page.name != "index.md" %} {% assign version = page.name | split: "." | first %} @@ -51,11 +52,18 @@ {% if page.lts %} + {% if active_lts_already_set == false %} + {% assign lts_label = "Active LTS" %} + {% assign active_lts_already_set = true %} + {% else %} + {% assign lts_label = "Maintenance LTS" %} + {% endif %} + - - Active LTS - + + {{ lts_label }} + @@ -110,6 +118,7 @@
  • Active LTS - releases supported for 18 months from initial release date
    • +
  • Maintenance LTS - older LTS releases still supported within the LTS window
  • Standard - releases supported for 6 months from initial release date
diff --git a/_includes/releases-table.sass b/_includes/releases-table.sass index a77643a673..40e343b1f6 100644 --- a/_includes/releases-table.sass +++ b/_includes/releases-table.sass @@ -18,7 +18,7 @@ &:nth-child(3) min-width: 175px &:nth-child(4) - min-width: 135px + min-width: 150px &:nth-child(5) min-width: 180px &:nth-child(6) From b8d34dac4eb1156d204df5e4d3e787a3df0784f0 Mon Sep 17 00:00:00 2001 From: d2eight Date: Wed, 28 Jan 2026 21:31:12 +0200 Subject: [PATCH 6/7] lts fix --- _includes/releases-table.liquid | 19 +++---------------- 1 file changed, 3 insertions(+), 16 deletions(-) diff --git a/_includes/releases-table.liquid b/_includes/releases-table.liquid index 161e9b2b6e..cc0c99c3e8 100644 --- a/_includes/releases-table.liquid +++ b/_includes/releases-table.liquid @@ -69,20 +69,13 @@ {% endif %} - + {{ lts_label }} -======= - class="releases-table-content-item version-link version-link-lts" - target="_blank"> - - Active LTS - ->>>>>>> aa552f6b9fddb793315b7d11bcad714709f4046d + style="color: {% if docsPrefix == "pe/" %}#1F8B4D{% elsif docsPrefix == "edge/" %}#2260A7{% elsif docsPrefix == "pe/edge/" %}#009688{% else %}#2a7dec{% endif %}"> + {% else %}
Standard
@@ -139,16 +132,10 @@
-<<<<<<< HEAD
  • Active LTS - releases supported for 18 months from initial release date
  • Maintenance LTS - older LTS releases still supported within the LTS window
  • Standard - releases supported for 6 months from initial release date
    • -======= -
      -
    • Active LTS - releases are supported for 18 months from the initial release date.
      • -
    • Standard - releases are supported for six months from the initial release date.
      • ->>>>>>> aa552f6b9fddb793315b7d11bcad714709f4046d
    From 6e9b144172241b169fb6b7867d8c672877735f38 Mon Sep 17 00:00:00 2001 From: d2eight Date: Thu, 29 Jan 2026 11:53:58 +0200 Subject: [PATCH 7/7] releases legend fix --- _includes/releases-table.liquid | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/releases-table.liquid b/_includes/releases-table.liquid index cc0c99c3e8..205f6395d0 100644 --- a/_includes/releases-table.liquid +++ b/_includes/releases-table.liquid @@ -132,7 +132,7 @@
    -
      +
      • Active LTS - releases supported for 18 months from initial release date
      • Maintenance LTS - older LTS releases still supported within the LTS window
      • Standard - releases supported for 6 months from initial release date