From 9f9fcc795647ec05d5e4df993b58ff81eea9995e Mon Sep 17 00:00:00 2001 From: Mohini Date: Wed, 15 Jan 2025 12:06:05 +0530 Subject: [PATCH 1/4] added versions page --- src/current/_data/old_versions.csv | 14 + src/current/_data/versions.csv | 13 - .../_includes/sidebar-all-releases.json | 6 + src/current/releases/index.md | 1 + src/current/releases/old-releases.md | 473 ++++++++++++++++++ 5 files changed, 494 insertions(+), 13 deletions(-) create mode 100644 src/current/_data/old_versions.csv create mode 100644 src/current/releases/old-releases.md diff --git a/src/current/_data/old_versions.csv b/src/current/_data/old_versions.csv new file mode 100644 index 00000000000..0412ade54a7 --- /dev/null +++ b/src/current/_data/old_versions.csv @@ -0,0 +1,14 @@ +major_version,release_date,maint_supp_exp_date,asst_supp_exp_date,last_ga_patch,initial_lts_patch,initial_lts_release_date,lts_maint_supp_exp_date,lts_asst_supp_exp_date,previous_version,crdb_branch_name +v1.0,2017-05-10,2018-05-10,2018-11-10,N/A,N/A,N/A,N/A,N/A,N/A,release-1.0 +v1.1,2017-10-12,2018-10-12,2019-04-12,N/A,N/A,N/A,N/A,N/A,v1.0,release-1.1 +v2.0,2018-04-04,2019-04-04,2019-10-04,N/A,N/A,N/A,N/A,N/A,v1.1,release-2.0 +v2.1,2018-10-30,2019-10-30,2020-04-30,N/A,N/A,N/A,N/A,N/A,v2.0,release-2.1 +v19.1,2019-04-30,2020-04-30,2020-10-30,N/A,N/A,N/A,N/A,N/A,v2.1,release-19.1 +v19.2,2019-11-12,2020-11-12,2021-05-12,N/A,N/A,N/A,N/A,N/A,v19.1,release-19.2 +v20.1,2020-05-12,2021-05-12,2021-11-12,N/A,N/A,N/A,N/A,N/A,v19.2,release-20.1 +v20.2,2020-11-10,2021-11-10,2022-05-10,N/A,N/A,N/A,N/A,N/A,v20.1,release-20.2 +v21.1,2021-05-18,2022-05-18,2022-11-18,N/A,N/A,N/A,N/A,N/A,v20.2,release-21.1 +v21.2,2021-11-16,2022-11-16,2023-05-16,N/A,N/A,N/A,N/A,N/A,v21.1,release-21.2 +v22.1,2022-05-24,2023-05-24,2023-11-24,N/A,N/A,N/A,N/A,N/A,v21.2,release-22.1 +v22.2,2022-12-05,2023-12-05,2024-06-05,N/A,N/A,N/A,N/A,N/A,v22.1,release-22.2 +v23.1,2023-05-15,2024-05-15,2024-11-15,23.1.11,23.1.12,2023-11-13,2024-11-13,2025-11-13,v22.2,release-23.1 \ No newline at end of file diff --git a/src/current/_data/versions.csv b/src/current/_data/versions.csv index 54feef3ef03..e3227bc8002 100644 --- a/src/current/_data/versions.csv +++ b/src/current/_data/versions.csv @@ -1,17 +1,4 @@ major_version,release_date,maint_supp_exp_date,asst_supp_exp_date,last_ga_patch,initial_lts_patch,initial_lts_release_date,lts_maint_supp_exp_date,lts_asst_supp_exp_date,previous_version,crdb_branch_name -v1.0,2017-05-10,2018-05-10,2018-11-10,N/A,N/A,N/A,N/A,N/A,N/A,release-1.0 -v1.1,2017-10-12,2018-10-12,2019-04-12,N/A,N/A,N/A,N/A,N/A,v1.0,release-1.1 -v2.0,2018-04-04,2019-04-04,2019-10-04,N/A,N/A,N/A,N/A,N/A,v1.1,release-2.0 -v2.1,2018-10-30,2019-10-30,2020-04-30,N/A,N/A,N/A,N/A,N/A,v2.0,release-2.1 -v19.1,2019-04-30,2020-04-30,2020-10-30,N/A,N/A,N/A,N/A,N/A,v2.1,release-19.1 -v19.2,2019-11-12,2020-11-12,2021-05-12,N/A,N/A,N/A,N/A,N/A,v19.1,release-19.2 -v20.1,2020-05-12,2021-05-12,2021-11-12,N/A,N/A,N/A,N/A,N/A,v19.2,release-20.1 -v20.2,2020-11-10,2021-11-10,2022-05-10,N/A,N/A,N/A,N/A,N/A,v20.1,release-20.2 -v21.1,2021-05-18,2022-05-18,2022-11-18,N/A,N/A,N/A,N/A,N/A,v20.2,release-21.1 -v21.2,2021-11-16,2022-11-16,2023-05-16,N/A,N/A,N/A,N/A,N/A,v21.1,release-21.2 -v22.1,2022-05-24,2023-05-24,2023-11-24,N/A,N/A,N/A,N/A,N/A,v21.2,release-22.1 -v22.2,2022-12-05,2023-12-05,2024-06-05,N/A,N/A,N/A,N/A,N/A,v22.1,release-22.2 -v23.1,2023-05-15,2024-05-15,2024-11-15,23.1.11,23.1.12,2023-11-13,2024-11-13,2025-11-13,v22.2,release-23.1 v23.2,2024-02-05,2025-02-05,2025-08-05,23.2.6,23.2.7,2024-07-08,2025-07-08,2026-07-08,v23.1,release-23.2 v24.1,2024-05-20,2025-05-20,2025-11-20,24.1.5,24.1.6,2024-10-21,2025-10-21,2026-10-21,v23.2,release-24.1 v24.2,2024-08-12,2025-02-12,N/A,N/A,N/A,N/A,N/A,N/A,v24.1,release-24.2 diff --git a/src/current/_includes/sidebar-all-releases.json b/src/current/_includes/sidebar-all-releases.json index bf130d229b9..e67d2c30f29 100644 --- a/src/current/_includes/sidebar-all-releases.json +++ b/src/current/_includes/sidebar-all-releases.json @@ -67,4 +67,10 @@ "urls": [ "/releases/kubernetes-operator.html" ] +}, +{ + "title": "Unsupported versions", + "urls": [ + "/releases/old-releases.html" + ] } diff --git a/src/current/releases/index.md b/src/current/releases/index.md index f7dd618a343..ee621506260 100644 --- a/src/current/releases/index.md +++ b/src/current/releases/index.md @@ -2,6 +2,7 @@ title: CockroachDB Releases summary: Information about CockroachDB releases with an index of available releases and their release notes and binaries. toc: true +# toc_not_nested: true docs_area: releases --- diff --git a/src/current/releases/old-releases.md b/src/current/releases/old-releases.md new file mode 100644 index 00000000000..cac78d12964 --- /dev/null +++ b/src/current/releases/old-releases.md @@ -0,0 +1,473 @@ +--- +title: Release Support Policy +summary: Learn about Cockroach Labs' policy for supporting major releases of CockroachDB. +toc: true +toc_not_nested: true +docs_area: releases +--- + +## Downloads + +{{ experimental_js_warning }} + +{% assign sections = site.data.releases | map: "release_type" | uniq | reverse %} +{% comment %} Fetch the list of all release types (currently Testing, Production) {% endcomment %} + +{% assign released_versions = site.data.releases | map: "major_version" | uniq | reverse %} +{% comment %} Fetch the list of the major versions of all releases that currently exist {% endcomment %} + +{% assign versions = site.data.old_versions | where_exp: "versions", "released_versions contains versions.major_version" | sort: "release_date" | reverse %} +{% comment %} Fetch all major versions (e.g., v21.2), sorted in reverse chronological order. {% endcomment %} + +{% assign latest_hotfix = site.data.releases | where_exp: "latest_hotfix", "latest_hotfix.major_version == site.versions['stable']" | where_exp: "latest_hotfix", "latest_hotfix.withdrawn != true" | sort: "release_date" | reverse | first %} +{% comment %} For the latest GA version, find the latest hotfix that is not withdrawn. {% endcomment %} + +{% comment %}Assign the JS for the experimental download prompt and store it in the Liquid variable experimental_download_js {% endcomment %} +{% capture experimental_download_js %}{% include_cached releases/experimental_download_dialog.md %}{% endcapture %} +{% capture onclick_string %}onclick="{{ experimental_download_js }}"{% endcapture %} + +{% assign is_not_downloadable_message = "No longer available for download." %} + +{% for v in versions %} {% comment %} Iterate through all major versions {% endcomment %} + + {% comment %} + Determine if the major version is LTS and the patch component of the initial LTS patch, + or the major version is a skippable innovation release + {% endcomment %} + {% assign released = false %} + {% assign has_lts_releases = false %} + {% assign lts_link_linux = '' %} + {% assign lts_patch = nil %} + {% assign in_lts = false %} + {% assign comparison = nil %} + {% assign skippable = false %} + {% if v.release_date != "N/A" and v.maint_supp_exp_date != "N/A" %} + {% assign released = true %} + {% if v.asst_supp_exp_date == "N/A" %} + {% assign skippable = true %} + {% elsif v.initial_lts_patch != "N/A" %} + {% assign has_lts_releases = true %} + {% assign lts_link = ' (LTS) ' %} + {% capture lts_patch_string %}{{ v.initial_lts_patch | split: '.' | shift | shift }}{% endcapture %} + {% assign lts_patch = lts_patch_string | times: 1 %}{% comment %}Cast string to integer {% endcomment %} + {% endif %} + {% endif %} + +### {{ v.major_version }} + +{% if DEBUG == true %} + released: {{ released }}
+ has_lts_releases: {{ has_lts_releases }}
+ lts_patch_string: {{ lts_patch_string }}
+ lts_patch: {{ lts_patch }}
+ v.initial_lts_patch: {{ v.initial_lts_patch }}
+ v.major_version: {{ v.major_version }}
+ has_lts_releases: {{ has_lts_releases }}
+ v.release_date: {{ v.release_date }}
+ v.initial_lts_release_date: {{ v.initial_lts_release_date }}
+ skippable: {{ skippable }}

+{% endif %} + +{% if released == false %} +CockroachDB {{ page.major_version }} is in active development and is not yet supported. The following [testing releases]({% link releases/index.md %}#release-types) are intended for testing and experimentation only, and are not qualified for production environments or eligible for support or uptime SLA commitments. When CockroachDB {{ page.major_version }} is Generally Available (GA), production releases will also be announced on this page. +{% else %} +CockroachDB {{ v.major_version }} is {% if skippable == true %}an [Innovation release]({% link releases/release-support-policy.md %}#innovation-releases) that is optional for CockroachDB {{ site.data.products.advanced }}, CockroachDB {{ site.data.products.standard }}, and CockroachDB {{ site.data.products.core }} but required for CockroachDB {{ site.data.products.basic }}.{% else %}a required [Regular release]({% link releases/release-support-policy.md %}#regular-releases).{% endif %}{% if released == false %} It is still in development and not yet supported.{% endif %}{% unless latest_full_production_version.release_name != v.major_version %} CockroachDB {{ latest_full_production_version.release_name }} is the latest supported version.{% endunless %} To learn more, refer to [CockroachDB {{ latest.major_version }} Release Notes]({% link releases/{{ v.major_version }}.md %}). +{% endif %} + +Refer to [Major release types](#major-releases) before installing or upgrading for release support details. +{% comment %}Some old pages don't have feature highlights and won't get LTS{% endcomment %} +{% unless v.major_version == 'v1.0' or + v.major_version == 'v1.1' or + v.major_version == 'v2.0' or + v.major_version == 'v2.1' or + v.major_version == 'v19.1' or + v.major_version == 'v19.2' or + v.major_version == 'v20.1' or + v.major_version == 'v20.2' or + v.major_version == 'v21.1' or + v.major_version == 'v21.2' or + v.major_version == 'v22.1' or + v.major_version == 'v22.2' or + released == false %} +To learn what’s new in this release, refer to [Feature Highlights]({% link releases/{{ v.major_version }}.md %}#feature-highlights). +{% endunless %} + +
+ + + + + +
+ + {% for s in sections %} {% comment %} For each major version, iterate through the sections. {% endcomment %} + + {% assign releases = site.data.releases | where_exp: "releases", "releases.major_version == v.major_version" | where_exp: "releases", "releases.release_type == s" | sort: "release_date" | reverse %} {% comment %} Fetch all releases for that major version based on release type (Production/Testing). {% endcomment %} + +{% comment %}Do a separate loop through the releases and for each release, copy some fields into some local v_ variables to use when we are not in a loop below{% endcomment %} + + {% assign v_linux_arm = false %} + {% for r in releases %} + {% if r.linux.linux_arm == true %} + {% assign v_linux_arm = true %} + {% break %} + {% endif %} + {% endfor %} + + {% assign v_mac_arm = false %} + {% for r in releases %} + {% if r.mac.mac_arm == true %} + {% assign v_mac_arm = true %} + {% break %} + {% endif %} + {% endfor %} + + {% assign v_docker_arm = false %} + {% for r in releases %} + {% if r.docker.docker_arm == true %} + {% assign v_docker_arm = true %} + {% break %} + {% endif %} + {% endfor %} + + {% if releases[0] %} + +#### {{ s }} Releases + +
+ + + + + + + + {% if v_linux_arm == true %} + + {% endif %} + + + + {% for r in releases %} + + {% assign current_patch_string = '' %} + {% assign current_patch = nil %} + {% assign in_lts = false %} + {% if has_lts_releases == true and s == "Production" %} + {% capture current_patch_string %}{{ r.release_name | split: '.' | shift | shift }}{% endcapture %} + {% assign current_patch = current_patch_string | times: 1 %}{% comment %}Cast string to integer {% endcomment %} + {% if current_patch == nil %} + Error: Could not determine the current patch. Giving up.
+ {% break %}{% break %} + {% endif %} + + {% assign comparison = current_patch | minus: lts_patch %} + {% unless comparison < 0 %} + {% assign in_lts = true %} + {% endunless %} + {% endif %} + + {% if DEBUG == true %}{% endif %} + + {% comment %} Add "Latest" class to release if it's the latest release. {% endcomment %} + + {% comment %} Release date of the release. {% endcomment %} + {% if r.withdrawn == true %} {% comment %} Suppress download links for withdrawn releases. {% endcomment %} + {% comment %}covers both Intel and ARM columns {% endcomment %} + {% continue %} + {% elsif r.cloud_only == true %} {% comment %} Suppress download links for Cloud-first releases {% endcomment %} + + {% continue %} + {% elsif r.is_not_downloadable == true %} {% comment %} Suppress download links for outdated versions. {% endcomment %} + + {% continue %} + {% else %} {% comment %} Add download links for all non-withdrawn versions. {% endcomment %} + + {% endif %} + {% endif %} + + {% endfor %} {% comment %}Releases {% endcomment %} + +
VersionDateIntel 64-bit DownloadsARM 64-bit Downloads
current_patch: {{ current_patch }}
lts_patch: {{ lts_patch }}
r.release_name: {{ r.release_name }}
lts_link: {{ lts_link }}
in_lts: {{ in_lts }}
+ {{ r.release_name }}{% if in_lts == true %}{{ lts_link }}{% endif %}{% comment %} Add link to each release r, decorate with link about LTS if applicable. {% endcomment %} + {% if r.release_name == latest_hotfix.release_name %} + Latest {% comment %} Add "Latest" badge to release if it's the latest release. {% endcomment %} + {% endif %} + {{ r.release_date }}Withdrawn{{ r.cloud_only_message_short }}{{ is_not_downloadable_message }} +
Full Binary{% if r.has_sha256sum == true %} (SHA256){% endif %}
{% comment %} If a sha256sum is available for a particular release, we display a link to the file containing the sha256sum alongside the download link of the release. {% endcomment %} + {% if r.has_sql_only == true %} +
SQL Shell Binary{% if r.has_sha256sum == true %} (SHA256{% endif %})
{% comment %} If a sha256sum is available for a particular release, we display a link to the file containing the sha256sum alongside the download link of the release. {% endcomment %} + {% endif %} + {% endif %} + {% if r.linux.linux_arm == true %} + {% comment %}Don't print column because of previous colspan=2{% endcomment %} + {% if r.withdrawn == true or r.cloud_only == true or r.is_not_downloadable == true %} + {% break %} + {% else %} + 		+ {% if r.linux.linux_arm_experimental == true %}Experimental:{% endif %} +
Full Binary{% if r.has_sha256sum == true %} (SHA256{% endif %})
{% comment %} If a sha256sum is available for a particular release, we display a link to the file containing the sha256sum alongside the download link of the release. {% endcomment %} + {% if r.has_sql_only == true %} +
SQL shell Binary{% if r.has_sha256sum == true %} (SHA256){% endif %}
{% comment %} If a sha256sum is available for a particular release, we display a link to the file containing the sha256sum alongside the download link of the release. {% endcomment %} + {% endif %} +
+
+ +
+ +macOS downloads are **experimental**. Experimental downloads are not yet qualified for production use and not eligible for support or uptime SLA commitments, whether they are for testing releases or production releases. + + + + + + + + {% if v_mac_arm == true %} + + {% endif %} + + + + {% for r in releases %} + + {% comment %} Add "Latest" class to release if it's the latest release. {% endcomment %} + + {% comment %} Release date of the release. {% endcomment %} + {% if r.withdrawn == true %} {% comment %} Suppress withdrawn releases. {% endcomment %} + {% comment %}covers both Intel and ARM columns {% endcomment %} + {% continue %} + {% elsif r.cloud_only == true %} {% comment %} Suppress download links for Cloud-first releases {% endcomment %} + + {% continue %} + {% elsif r.is_not_downloadable == true %} {% comment %} Suppress download links for outdated versions. {% endcomment %} + + {% continue %} + {% else %} {% comment %} Add download links for all non-withdrawn versions. {% endcomment %} + + {% endif %} + {% endif %} + + {% endfor %} + +
VersionDateIntel 64-bit (Experimental) DownloadsARM 64-bit (Experimental) Downloads
+ {{ r.release_name }} {% comment %} Add link to each release r. {% endcomment %} + {% if r.release_name == latest_hotfix.release_name %} + Latest {% comment %} Add "Latest" badge to release if it's the latest release. {% endcomment %} + {% endif %} + {{ r.release_date }}Withdrawn{{ r.cloud_only_message_short }}{{ is_not_downloadable_message }} +
Full Binary{% if r.has_sha256sum == true %} (SHA256){% endif %}
{% comment %} If a sha256sum is available for a particular release, we display a link to the file containing the sha256sum alongside the download link of the release. {% endcomment %} + {% if r.has_sql_only == true %} +
SQL shell Binary{% if r.has_sha256sum == true %} (SHA256){% endif %}
{% comment %} If a sha256sum is available for a particular release, we display a link to the file containing the sha256sum alongside the download link of the release. {% endcomment %} + {% endif %} + {% endif %} + {% if r.mac.mac_arm == true %} + {% comment %}Don't print column because of previous colspan=2{% endcomment %} + {% if r.withdrawn == true or r.cloud_only == true or r.is_not_downloadable == true %} + {% break %} + {% else %} + 		+
Full Binary{% if r.has_sha256sum == true %} (SHA256){% endif %}
+ {% if r.has_sql_only == true %} +
SQL shell Binary{% if r.has_sha256sum == true %} (SHA256){% endif %}
+ {% endif %} +
+ +
+ +
+ Windows 8 or higher is required. Windows downloads are **experimental**. Experimental downloads are not yet qualified for production use and not eligible for support or uptime SLA commitments, whether they are for testing releases or production releases. + + + + + + + + + + + {% for r in releases %} + + + {% comment %} Add "Latest" class to release if it's the latest release. {% endcomment %} + + {% comment %} Release date of the release. {% endcomment %} + {% if r.withdrawn == true %} {% comment %} Suppress withdrawn releases. {% endcomment %} + {% comment %}covers both Intel and ARM columns {% endcomment %} + {% continue %} + {% elsif r.cloud_only == true %} {% comment %} Suppress download links for Cloud-first releases {% endcomment %} + + {% continue %} + {% elsif r.is_not_downloadable == true %} {% comment %} Suppress download links for outdated versions. {% endcomment %} + + {% continue %} + {% else %} {% comment %} Add download links for all non-withdrawn versions. {% endcomment %} + + + {% endfor %} + +
VersionDateIntel 64-bit (Experimental) Downloads
+ {{ r.release_name }} {% comment %} Add link to each release r. {% endcomment %} + {% if r.release_name == latest_hotfix.release_name %} + Latest {% comment %} Add "Latest" badge to release if it's the latest release. {% endcomment %} + {% endif %} + {{ r.release_date }}Withdrawn{{ r.cloud_only_message_short }}{{ is_not_downloadable_message }} + {% if r.windows == true %} +
Full Binary{% if r.has_sha256sum == true %} (SHA256){% endif %}
{% comment %} If a sha256sum is available for a particular release, we display a link to the file containing the sha256sum alongside the download link of the release. {% endcomment %} + {% if r.has_sql_only == true %} +
SQL shell Binary{% if r.has_sha256sum == true %} (SHA256){% endif %}
{% comment %} If a sha256sum is available for a particular release, we display a link to the file containing the sha256sum alongside the download link of the release. {% endcomment %} + {% endif %} + {% else %} + N/A + {% endif %} + {% endif %} +
+
+ +
+ + {% comment %}Prepare to show the Notes column in v22.2 and v23.1{% endcomment %} + {% assign show_notes_column = false %} + {% if v.major_version == "v23.1" or v.major_version == "v22.2" %} + {% assign show_notes_column = true %} + {% endif %} + + {% if s == "Production" %}{% comment %}Print this only for the Production section{% endcomment %} + Docker images for CockroachDB are published on [Docker Hub](https://hub.docker.com/r/cockroachdb/cockroach/tags). + + {% if show_notes_column == true %} + [Multi-platform images](https://docs.docker.com/build/building/multi-platform/) include support for both Intel and ARM. + {% else %} + All Docker images for {{ v.major_version }} are [Multi-platform images](https://docs.docker.com/build/building/multi-platform/) with support for both Intel and ARM. + {% endif %} + {% endif %} + + + + + + + + {% if show_notes_column == true %}{% endif %} + + + + {% for r in releases %} + + {% assign current_patch_string = '' %} + {% assign current_patch = nil %} + {% assign in_lts = false %} + {% if has_lts_releases == true and s == "Production" %} + {% capture current_patch_string %}{{ r.release_name | split: '.' | shift | shift }}{% endcapture %} + {% assign current_patch = current_patch_string | times: 1 %}{% comment %}Cast string to integer {% endcomment %} + {% if current_patch == nil %} + Error: Could not determine the current patch. Giving up.
+ {% break %}{% break %} + {% endif %} + + {% assign comparison = current_patch | minus: lts_patch %} + {% unless comparison < 0 %} + {% assign in_lts = true %} + {% endunless %} + {% endif %} + + {% comment %} Add "Latest" class to release if it's the latest release. {% endcomment %} + + {% comment %}Version column{% endcomment %} + + + {% comment %}Release Date column{% endcomment %} + {% comment %} Release date of the release. {% endcomment %} + + {% comment %}Docker Image Tag column{% endcomment %} + {% comment %} Suppress download links for withdrawn releases, spans Intel and ARM columns {% endcomment %} + {% elsif r.cloud_only == true %} {% comment %} Suppress download links for Cloud-first releases, spans Intel and ARM columns {% endcomment %} + {{ r.cloud_only_message_short }} + {% elsif r.is_not_downloadable == true %} {% comment %} Suppress download links for outdated versions. {% endcomment %} + {{ is_not_downloadable_message }} + {% continue %} + {% else %} + {% if r.source == false %} + N/A + {% else %} + {% if show_notes_column == true %}{% comment %}Show Intel and ARM details only for major versions with a mix{% endcomment %} + {% if r.docker.docker_arm == false %}Intel:
{% else %}Multi-platform:
{% endif %} + {% endif %}{{ r.docker.docker_image }}:{{ r.release_name }} + {% endif %} + {% endif %} + + {% if show_notes_column == true %} + {% comment %}Notes column{% endcomment %} + + {% endif %} + + {% endfor %} + +
VersionDateDocker image tagNotes
{{ r.release_name }}{% if in_lts == true %}{{ lts_link }}{% endif %}{% comment %} Add link to each release r.{% endcomment %} + {% if r.release_name == latest_hotfix.release_name %} + Latest {% comment %} Add "Latest" badge to release if it's the latest release. {% endcomment %} + {% endif %} + {{ r.release_date }} + {% if r.withdrawn == true %} + Withdrawn + {% if r.docker.docker_arm_limited_access == true %} + **Intel**: Production
**ARM**: Limited Access + {% elsif r.docker.docker_arm_experimental == true %} + **Intel**: Production
**ARM**: Experimental + {% else %} + Production + {% endif %} +
+
+ +
+

The source code for CockroachDB is hosted in the cockroachdb/cockroach repository on Github.

+ + + + + + + + + + {% for r in releases %} + + {% comment %} Add "Latest" class to release if it's the latest release. {% endcomment %} + + {% comment %} Release date of the release. {% endcomment %} + {% if r.withdrawn == true %} {% comment %} Suppress withdrawn releases. {% endcomment %} + + {% continue %} + {% elsif r.cloud_only == true %} {% comment %} Suppress download links for Cloud-first releases {% endcomment %} + + {% continue %} + {% elsif r.is_not_downloadable == true %} {% comment %} Suppress download links for outdated versions. {% endcomment %} + + {% continue %} + {% else %} {% comment %} Add download links for all non-withdrawn versions. {% endcomment %} + + {% endif %} + + {% endfor %} {% comment %}for release in releases{% endcomment %} + +
VersionDateSource
+ {{ r.release_name }}{% comment %} Add link to each release r {% endcomment %} + {% if r.release_name == latest_hotfix.release_name %} + Latest {% comment %} Add "Latest" badge to release if it's the latest release. {% endcomment %} + {% endif %} + {{ r.release_date }}Withdrawn{{ r.cloud_only_message_short }}{{ is_not_downloadable_message }} + {% if r.source == true %} + View on Github + {% else %} + N/A + {% endif %} +
+
+ + + {% endif %} {% comment %}if releases[0]{% endcomment %} + {% endfor %} {% comment %}for s in sections {% endcomment %} +{% endfor %} {% comment %}for v in versions{% endcomment %} From 858c68d98b8d24869d19faa411163f0edc9e17f5 Mon Sep 17 00:00:00 2001 From: Mohini Date: Fri, 17 Jan 2025 09:36:31 +0530 Subject: [PATCH 2/4] added sidenav bar changes with replacing EOL with unsupported --- src/current/_data/supported_versions.csv | 6 ++++++ .../{old_versions.csv => unsupported_versions.csv} | 0 src/current/_data/versions.csv | 13 +++++++++++++ src/current/_includes/sidebar-all-releases.json | 2 +- src/current/_includes/sidebar-releases.json | 7 +++++++ src/current/advisories/a48860.md | 2 +- src/current/cockroachcloud/alerts-page.md | 2 +- src/current/js/customscripts.js | 10 +++------- src/current/releases/index.md | 5 ++++- src/current/releases/release-support-policy.md | 10 +++++----- .../{old-releases.md => unsupported-versions.md} | 7 +++---- 11 files changed, 44 insertions(+), 20 deletions(-) create mode 100644 src/current/_data/supported_versions.csv rename src/current/_data/{old_versions.csv => unsupported_versions.csv} (100%) rename src/current/releases/{old-releases.md => unsupported-versions.md} (99%) diff --git a/src/current/_data/supported_versions.csv b/src/current/_data/supported_versions.csv new file mode 100644 index 00000000000..f3c991fb942 --- /dev/null +++ b/src/current/_data/supported_versions.csv @@ -0,0 +1,6 @@ +major_version,release_date,maint_supp_exp_date,asst_supp_exp_date,last_ga_patch,initial_lts_patch,initial_lts_release_date,lts_maint_supp_exp_date,lts_asst_supp_exp_date,previous_version,crdb_branch_name +v23.2,2024-02-05,2025-02-05,2025-08-05,23.2.6,23.2.7,2024-07-08,2025-07-08,2026-07-08,v23.1,release-23.2 +v24.1,2024-05-20,2025-05-20,2025-11-20,24.1.5,24.1.6,2024-10-21,2025-10-21,2026-10-21,v23.2,release-24.1 +v24.2,2024-08-12,2025-02-12,N/A,N/A,N/A,N/A,N/A,N/A,v24.1,release-24.2 +v24.3,2024-11-18,2025-11-18,2026-05-18,N/A,N/A,N/A,N/A,N/A,v24.2,release-24.3 +v25.1,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,v24.2,release-24.3 \ No newline at end of file diff --git a/src/current/_data/old_versions.csv b/src/current/_data/unsupported_versions.csv similarity index 100% rename from src/current/_data/old_versions.csv rename to src/current/_data/unsupported_versions.csv diff --git a/src/current/_data/versions.csv b/src/current/_data/versions.csv index e3227bc8002..54feef3ef03 100644 --- a/src/current/_data/versions.csv +++ b/src/current/_data/versions.csv @@ -1,4 +1,17 @@ major_version,release_date,maint_supp_exp_date,asst_supp_exp_date,last_ga_patch,initial_lts_patch,initial_lts_release_date,lts_maint_supp_exp_date,lts_asst_supp_exp_date,previous_version,crdb_branch_name +v1.0,2017-05-10,2018-05-10,2018-11-10,N/A,N/A,N/A,N/A,N/A,N/A,release-1.0 +v1.1,2017-10-12,2018-10-12,2019-04-12,N/A,N/A,N/A,N/A,N/A,v1.0,release-1.1 +v2.0,2018-04-04,2019-04-04,2019-10-04,N/A,N/A,N/A,N/A,N/A,v1.1,release-2.0 +v2.1,2018-10-30,2019-10-30,2020-04-30,N/A,N/A,N/A,N/A,N/A,v2.0,release-2.1 +v19.1,2019-04-30,2020-04-30,2020-10-30,N/A,N/A,N/A,N/A,N/A,v2.1,release-19.1 +v19.2,2019-11-12,2020-11-12,2021-05-12,N/A,N/A,N/A,N/A,N/A,v19.1,release-19.2 +v20.1,2020-05-12,2021-05-12,2021-11-12,N/A,N/A,N/A,N/A,N/A,v19.2,release-20.1 +v20.2,2020-11-10,2021-11-10,2022-05-10,N/A,N/A,N/A,N/A,N/A,v20.1,release-20.2 +v21.1,2021-05-18,2022-05-18,2022-11-18,N/A,N/A,N/A,N/A,N/A,v20.2,release-21.1 +v21.2,2021-11-16,2022-11-16,2023-05-16,N/A,N/A,N/A,N/A,N/A,v21.1,release-21.2 +v22.1,2022-05-24,2023-05-24,2023-11-24,N/A,N/A,N/A,N/A,N/A,v21.2,release-22.1 +v22.2,2022-12-05,2023-12-05,2024-06-05,N/A,N/A,N/A,N/A,N/A,v22.1,release-22.2 +v23.1,2023-05-15,2024-05-15,2024-11-15,23.1.11,23.1.12,2023-11-13,2024-11-13,2025-11-13,v22.2,release-23.1 v23.2,2024-02-05,2025-02-05,2025-08-05,23.2.6,23.2.7,2024-07-08,2025-07-08,2026-07-08,v23.1,release-23.2 v24.1,2024-05-20,2025-05-20,2025-11-20,24.1.5,24.1.6,2024-10-21,2025-10-21,2026-10-21,v23.2,release-24.1 v24.2,2024-08-12,2025-02-12,N/A,N/A,N/A,N/A,N/A,N/A,v24.1,release-24.2 diff --git a/src/current/_includes/sidebar-all-releases.json b/src/current/_includes/sidebar-all-releases.json index e67d2c30f29..d4df619a262 100644 --- a/src/current/_includes/sidebar-all-releases.json +++ b/src/current/_includes/sidebar-all-releases.json @@ -71,6 +71,6 @@ { "title": "Unsupported versions", "urls": [ - "/releases/old-releases.html" + "/releases/unsupported-versions.html" ] } diff --git a/src/current/_includes/sidebar-releases.json b/src/current/_includes/sidebar-releases.json index 351e4192850..0df726ab7c8 100644 --- a/src/current/_includes/sidebar-releases.json +++ b/src/current/_includes/sidebar-releases.json @@ -79,4 +79,11 @@ ,"{{ x.url }}" {% endfor %} ] +}, +{ + "title": "Unsupported versions", + "urls": [ + "/releases/unsupported-versions.html" + ] } + diff --git a/src/current/advisories/a48860.md b/src/current/advisories/a48860.md index e4fb54d2a07..a360bbc47ff 100644 --- a/src/current/advisories/a48860.md +++ b/src/current/advisories/a48860.md @@ -26,7 +26,7 @@ The public issue is tracked as [#48860](https://github.com/cockroachdb/cockroach There is no mitigation possible without an upgrade. Cockroach Labs recommends that customers upgrade to the latest release of [v19.1](https://www.cockroachlabs.com/docs/v19.1/upgrade-cockroach-version), [v19.2](https://www.cockroachlabs.com/docs/v19.2/upgrade-cockroach-version), or [v20.1](https://www.cockroachlabs.com/docs/v20.1/upgrade-cockroach-version.html), all of which are currently under [Maintenance Support](https://www.cockroachlabs.com/docs/releases/release-support-policy#support-cycle). -Because CockroachDB v2.1 will reach [End of Life](https://www.cockroachlabs.com/docs/releases/release-support-policy#support-cycle) on July 1, 2020, no new maintenance release for v2.1 will be issued containing a fix for this bug. Affected deployments running v2.1 should be upgraded to at least the latest release of [v19.1](https://www.cockroachlabs.com/docs/v19.1/upgrade-cockroach-version). +Because CockroachDB v2.1 will reach [unsupported](https://www.cockroachlabs.com/docs/releases/release-support-policy#support-cycle) on July 1, 2020, no new maintenance release for v2.1 will be issued containing a fix for this bug. Affected deployments running v2.1 should be upgraded to at least the latest release of [v19.1](https://www.cockroachlabs.com/docs/v19.1/upgrade-cockroach-version). ## Impact diff --git a/src/current/cockroachcloud/alerts-page.md b/src/current/cockroachcloud/alerts-page.md index 15f3c04ff6d..96eb84afbf3 100644 --- a/src/current/cockroachcloud/alerts-page.md +++ b/src/current/cockroachcloud/alerts-page.md @@ -20,7 +20,7 @@ The **Alerts** page is applicable for CockroachDB {{ site.data.products.advanced - A cluster is scheduled for an automatic [patch version upgrade]({% link cockroachcloud/upgrade-policy.md %}#patch-version-upgrades) and again after the upgrade is complete. - When a cluster is scheduled for [maintenance]({% link cockroachcloud/advanced-cluster-management.md %}#set-a-maintenance-window) that could temporarily impact the cluster's performance. -- When a cluster's CockroachDB version is nearing [end of life]({% link releases/release-support-policy.md %}#support-phases) and must be upgraded to maintain support. +- When a cluster's CockroachDB version is nearing [unsupported]({% link releases/release-support-policy.md %}#support-phases) and must be upgraded to maintain support. ### CMEK diff --git a/src/current/js/customscripts.js b/src/current/js/customscripts.js index 8fe76053b57..957e3acc758 100755 --- a/src/current/js/customscripts.js +++ b/src/current/js/customscripts.js @@ -20,14 +20,10 @@ function renderTOC() { }); // Set class on top level elements - if(document.getElementById('toc-right') && (document.getElementById('toc-right').children.length > 0)){ - var list = document.getElementById('toc-right').children[0].childNodes; - for (let li of list) { - li.classList.add('toc-li-top'); - } - } + var list = document.querySelectorAll('#toc-right > ul > li'); +list.forEach(li => li.classList.add('toc-li-top')); } - +document.addEventListener('DOMContentLoaded', renderTOC); var $versionSwitcher, versionSwitcherBottom = Infinity; const cockroachDomains = [ diff --git a/src/current/releases/index.md b/src/current/releases/index.md index ee621506260..aeb388e473b 100644 --- a/src/current/releases/index.md +++ b/src/current/releases/index.md @@ -140,7 +140,7 @@ The following releases and their descriptions represent proposed plans that are {% assign released_versions = site.data.releases | map: "major_version" | uniq | reverse %} {% comment %} Fetch the list of the major versions of all releases that currently exist {% endcomment %} -{% assign versions = site.data.versions | where_exp: "versions", "released_versions contains versions.major_version" | sort: "release_date" | reverse %} +{% assign versions = site.data.supported_versions | where_exp: "versions", "released_versions contains versions.major_version" | sort: "release_date" | reverse %} {% comment %} Fetch all major versions (e.g., v21.2), sorted in reverse chronological order. {% endcomment %} {% assign latest_hotfix = site.data.releases | where_exp: "latest_hotfix", "latest_hotfix.major_version == site.versions['stable']" | where_exp: "latest_hotfix", "latest_hotfix.withdrawn != true" | sort: "release_date" | reverse | first %} @@ -603,3 +603,6 @@ All binaries available on this page released on or after the day 24.3.0 is relea All binaries available on this page released prior to the release date of 24.3.0 are variously licensed under the Business Source License 1.1 (BSL), the CockroachDB Community License (CCL), and other licenses specified in the source code. To review the CCL, refer to the [CockroachDB Community License](https://www.cockroachlabs.com/cockroachdb-community-license) page. You can find the applicable Business Source License or third party licenses by reviewing these in the `licenses` folder for the applicable version of CockroachDB in the GitHub repository [cockroachdb/cockroach](https://github.com/cockroachdb/cockroach). See individual files for details. + +## [Unsupported versions]({% link releases/unsupported-versions.md %}) + diff --git a/src/current/releases/release-support-policy.md b/src/current/releases/release-support-policy.md index abe549250c8..14f82621070 100644 --- a/src/current/releases/release-support-policy.md +++ b/src/current/releases/release-support-policy.md @@ -28,15 +28,15 @@ There are two major release types: [Regular and Innovation releases]({% link rel - Patch releases for the purpose of resolving bugs or other errors may no longer be made to the major release. - Cockroach Labs may direct customers to workarounds or other fixes applicable to the reported case. - Cockroach Labs may direct customers to [upgrade](https://www.cockroachlabs.com/docs/stable/upgrade-cockroach-version) to a later version of CockroachDB to resolve or further troubleshoot an issue. -- **End of Life (EOL)**: The day that a major version’s final support period ends is its EOL date. After a version reaches EOL, Cockroach Labs provides no further support for the release. - - A Regular release reaches EOL at the Assistance Support phase's end date. - - An Innovation releases reaches EOL at the Maintenance Support phase's end date. +- **Unsupported**: The day that a major version’s final support period ends is its unsupported date. After a version reaches end of life, Cockroach Labs provides no further support for the release. + - A Regular release reaches unsupported at the Assistance Support phase's end date. + - An Innovation releases reaches unsupported at the Maintenance Support phase's end date. ## Support Types ### Regular releases -Initially, a Regular release series has GA Support. After the series demonstrates a continuously high level of stability and performance, new patch releases are designated as LTS releases, which have an extended support window for each [support phase](#support-phases): Maintenance Support, Assistance Support, and EOL (End of Life). +Initially, a Regular release series has GA Support. After the series demonstrates a continuously high level of stability and performance, new patch releases are designated as LTS releases, which have an extended support window for each [support phase](#support-phases): Maintenance Support, Assistance Support, and Unsupported versions. - **GA Support**: The default support type for production releases, starting with the initial production release of a major version, followed by each subsequent patch release before LTS releases begin for that major version. - **Maintenance support ends**: @@ -169,7 +169,7 @@ Innovation releases are not eligible for Assistance Support, and reach EOL at th *  : This major version will receive LTS patch releases, which will be listed on an additional row, upon their availability.
**  : This major version is an optional innovation release and will not receive receive LTS patch releases. Innovation releases are EOL when Maintenance Support ends.
-## End-of-life (EOL) versions +## Unsupported versions The following versions of CockroachDB are no longer supported. diff --git a/src/current/releases/old-releases.md b/src/current/releases/unsupported-versions.md similarity index 99% rename from src/current/releases/old-releases.md rename to src/current/releases/unsupported-versions.md index cac78d12964..a2019593530 100644 --- a/src/current/releases/old-releases.md +++ b/src/current/releases/unsupported-versions.md @@ -1,8 +1,7 @@ --- -title: Release Support Policy -summary: Learn about Cockroach Labs' policy for supporting major releases of CockroachDB. +title: Unsupported versions +summary: Versions of CockroachDB that are no longer supported toc: true -toc_not_nested: true docs_area: releases --- @@ -16,7 +15,7 @@ docs_area: releases {% assign released_versions = site.data.releases | map: "major_version" | uniq | reverse %} {% comment %} Fetch the list of the major versions of all releases that currently exist {% endcomment %} -{% assign versions = site.data.old_versions | where_exp: "versions", "released_versions contains versions.major_version" | sort: "release_date" | reverse %} +{% assign versions = site.data.unsupported_versions | where_exp: "versions", "released_versions contains versions.major_version" | sort: "release_date" | reverse %} {% comment %} Fetch all major versions (e.g., v21.2), sorted in reverse chronological order. {% endcomment %} {% assign latest_hotfix = site.data.releases | where_exp: "latest_hotfix", "latest_hotfix.major_version == site.versions['stable']" | where_exp: "latest_hotfix", "latest_hotfix.withdrawn != true" | sort: "release_date" | reverse | first %} From 7d1c5b1e7d065778c7e403206115f3e1470d0623 Mon Sep 17 00:00:00 2001 From: Mohini Date: Fri, 17 Jan 2025 13:55:44 +0530 Subject: [PATCH 3/4] fixed links --- src/current/releases/index.md | 2 +- src/current/releases/unsupported-versions.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/current/releases/index.md b/src/current/releases/index.md index 9a1f889fd33..ee5d68db288 100644 --- a/src/current/releases/index.md +++ b/src/current/releases/index.md @@ -117,7 +117,7 @@ As of 2024, CockroachDB is released under a staged delivery process. New release | [v24.2](#v24-2) | Innovation | 2024-08-12 | | [v24.1](#v24-1) | Regular | 2024-05-20 | | [v23.2](#v23-2) | Regular | 2024-02-05 | -| [v23.1](#v23-1) | Regular | 2023-05-15 | +| [v23.1](https://www.cockroachlabs.com/docs/releases/unsupported-versions#v23-1) | Regular | 2023-05-15 | ### Upcoming releases diff --git a/src/current/releases/unsupported-versions.md b/src/current/releases/unsupported-versions.md index a2019593530..1e8cf9560b2 100644 --- a/src/current/releases/unsupported-versions.md +++ b/src/current/releases/unsupported-versions.md @@ -73,7 +73,7 @@ CockroachDB {{ page.major_version }} is in active development and is not yet sup CockroachDB {{ v.major_version }} is {% if skippable == true %}an [Innovation release]({% link releases/release-support-policy.md %}#innovation-releases) that is optional for CockroachDB {{ site.data.products.advanced }}, CockroachDB {{ site.data.products.standard }}, and CockroachDB {{ site.data.products.core }} but required for CockroachDB {{ site.data.products.basic }}.{% else %}a required [Regular release]({% link releases/release-support-policy.md %}#regular-releases).{% endif %}{% if released == false %} It is still in development and not yet supported.{% endif %}{% unless latest_full_production_version.release_name != v.major_version %} CockroachDB {{ latest_full_production_version.release_name }} is the latest supported version.{% endunless %} To learn more, refer to [CockroachDB {{ latest.major_version }} Release Notes]({% link releases/{{ v.major_version }}.md %}). {% endif %} -Refer to [Major release types](#major-releases) before installing or upgrading for release support details. +Refer to [Major release types](https://www.cockroachlabs.com/docs/releases#major-releases) before installing or upgrading for release support details. {% comment %}Some old pages don't have feature highlights and won't get LTS{% endcomment %} {% unless v.major_version == 'v1.0' or v.major_version == 'v1.1' or From b504635110ecdc05f94892b859e712fd38ee43c4 Mon Sep 17 00:00:00 2001 From: Mohini Date: Sat, 18 Jan 2025 00:41:26 +0530 Subject: [PATCH 4/4] added change suggested by shannon --- src/current/releases/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/current/releases/index.md b/src/current/releases/index.md index ee5d68db288..1bc052c654c 100644 --- a/src/current/releases/index.md +++ b/src/current/releases/index.md @@ -604,5 +604,6 @@ All binaries available on this page released prior to the release date of 24.3.0 To review the CCL, refer to the [CockroachDB Community License](https://www.cockroachlabs.com/cockroachdb-community-license) page. You can find the applicable Business Source License or third party licenses by reviewing these in the `licenses` folder for the applicable version of CockroachDB in the GitHub repository [cockroachdb/cockroach](https://github.com/cockroachdb/cockroach). See individual files for details. -## [Unsupported versions]({% link releases/unsupported-versions.md %}) +## Unsupported versions +[Here]({% link releases/unsupported-versions.md %}) are the versions of CockroachDB that are no longer supported