From 9c3257e89f7fffcde60e138bba216d49276b3fb6 Mon Sep 17 00:00:00 2001 From: Matt Linville Date: Tue, 15 Oct 2024 12:24:09 -0700 Subject: [PATCH 1/2] Add back testing release logic to What's New page --- .../_includes/releases/whats-new-intro.md | 17 +++++++++++++---- src/current/releases/v24.3.md | 8 -------- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/src/current/_includes/releases/whats-new-intro.md b/src/current/_includes/releases/whats-new-intro.md index 0c7a15cb38e..738c61e4c88 100644 --- a/src/current/_includes/releases/whats-new-intro.md +++ b/src/current/_includes/releases/whats-new-intro.md @@ -1,5 +1,6 @@ {% assign DEBUG = false %} {% assign branched = false %} +{% assign released = false %} {% assign old = false %} {% assign no_highlights = false %} {% assign skippable = false %} @@ -33,6 +34,7 @@ page.major_version == 'v22.1' or page.major_version == 'v22.2' %} {% assign branched = true %} + {% assign released = true %} {% assign no_highlights = true %} {% assign will_never_have_lts = true %} {% endif %} @@ -58,6 +60,7 @@ {% comment %}Is it skippable or LTS?{% endcomment %} {% if include.major_version.release_date != "N/A" %} + {% assign released = true %} {% if include.major_version.asst_supp_exp_date == "N/A" %} {% assign skippable = true %} {% elsif include.major_version.initial_lts_patch != "N/A" %} @@ -69,6 +72,7 @@ include.major_version: {{ include.major_version }}
page.major_version: {{ page.major_version }}
branched: {{ branched }}
+released: {{ released }}
will_never_have_lts: {{ will_never_have_lts }}
lts: {{ lts }}
skippable: {{ skippable }}
@@ -76,18 +80,23 @@ no_highlights: {{ no_highlights }}

{% endif %} -{% if skippable == true %} -CockroachDB {{ page.major_version }} is an [Innovation Release]({% link releases/release-support-policy.md %}#support-types), which is optional for CockroachDB {{ site.data.products.dedicated }} and CockroachDB {{ site.data.products.core }} clusters but is required for CockroachDB {{ site.data.products.serverless }}. -{% else %} +{% if released == false %} +CockroachDB {{ page.major_version }} is in active development, and 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 %}{% comment %}Begin GA-only content{% endcomment %} + {% if skippable == true %} +CockroachDB {{ page.major_version }} is an [Innovation Release]({% link releases/release-support-policy.md %}#support-types), which is optional for CockroachDB {{ site.data.products.advanced }}, CockroachDB {{ site.data.products.standard }}, and CockroachDB {{ site.data.products.core }} clusters but is required for CockroachDB {{ site.data.products.basic }}. + {% else %} CockroachDB {{ page.major_version }}{% if lts == true %} [(LTS)]({% link releases/release-support-policy.md %}#support-phases){% endif %} is a required [Regular Release]({% link releases/release-support-policy.md %}#support-types). -{% endif %} + {% endif %} Refer to [Major release types]({% link releases/release-support-policy.md %}#support-types) before installing or upgrading for release timing and support details.{% if no_highlights == false %} To learn what’s new in this release, refer to its [Feature Highlights](#feature-highlights).{% endif %} On this page, you can read about changes and find downloads for all production and testing releases of CockroachDB {{ page.major_version }}{% if lts == true %} [(LTS)]({% link releases/release-support-policy.md %}#support-phases){% endif %} + {% comment %}v1.0 has no #v1-0-0 anchor, and before GA other releases also do not.{% endcomment %} - For key feature enhancements in {{ page.major_version }} and other upgrade considerations, refer to the notes for {% if include.major_version.release_date != 'N/A' and page.major_version != 'v1.0' %}[{{ page.major_version }}.0](#{{ page.major_version | replace: '.', '-' }}-0){% else %}{{ page.major_version }} on this page{% endif %}. +{% endif %}{% comment %}End GA-only content{% endcomment %} - For details about release types, naming, and licensing, refer to the [Releases]({% link releases/index.md %}) page. - Be sure to also review the [Release Support Policy]({% link releases/release-support-policy.md %}). - {{ install_sentence | strip_newlines }} diff --git a/src/current/releases/v24.3.md b/src/current/releases/v24.3.md index bdba157a362..cbccca6d0cc 100644 --- a/src/current/releases/v24.3.md +++ b/src/current/releases/v24.3.md @@ -31,11 +31,3 @@ docs_area: releases {% else %} No releases are available for this version. See the [Releases]({% link releases/index.md %}) page for all available releases. {% endif %} - -{% comment %}TODO: Remove these on GA{% endcomment %} - - - - - - \ No newline at end of file From d2e3eac7247a2c3624b28d0a88fb60f9db40d331 Mon Sep 17 00:00:00 2001 From: Matt Linville Date: Tue, 15 Oct 2024 12:24:23 -0700 Subject: [PATCH 2/2] Add back testing release logic to Releases index --- src/current/releases/index.md | 51 +++++++++++++++++++---------------- 1 file changed, 28 insertions(+), 23 deletions(-) diff --git a/src/current/releases/index.md b/src/current/releases/index.md index d33404c18de..3e92ee37b0c 100644 --- a/src/current/releases/index.md +++ b/src/current/releases/index.md @@ -28,7 +28,7 @@ indented in relation to the other Liquid. Please try to keep the indentation con This page explains the types and naming of CockroachDB releases and provides access to the release notes and downloads for all CockroachDB [releases](#downloads). -A new major version of CockroachDB is released quarterly. After a series of testing releases, each major version receives an initial production release, follwed by a series of patch releases. +A new major version of CockroachDB is released quarterly. After a series of testing releases, each major version receives an initial production release, followed by a series of patch releases. Releases are named in the format `vYY.R.PP`, where `YY` indicates the year, `R` indicates the major release starting with `1` each year, and `PP` indicates the patch number, starting with `0`. @@ -47,21 +47,21 @@ Be sure to review Cockroach Labs' [Release Support Policy]({% link releases/rele #### Major releases -As of 2024, every second major version is an **Innovation release**. For CockroachDB {{ site.data.products.core }} and CockroachDB {{ site.data.products.dedicated }}, these releases offer shorter support windows and can be skipped. +As of 2024, every second major version is an **Innovation release**. For CockroachDB {{ site.data.products.core }}, CockroachDB {{ site.data.products.standard }}, and CockroachDB {{ site.data.products.advanced }}, these releases offer shorter support windows and can be skipped. Innovation releases are required for CockroachDB {{ site.data.products.basic }}. -All other major versions are **Regular releases**, which are required upgrades. These versions offer longer support periods, which, for self-hosted clusters, are further extended when a patch version is announced that begins their **LTS** (Long-Term Support) release series. +All other major versions are **Regular releases**, which are required upgrades. These versions offer longer support periods, which, for CockroachDB {{ site.data.products.core }} clusters, are further extended when a patch version is announced that begins their **LTS** (Long-Term Support) release series. -For details on how this impacts support in CockroachDB {{ site.data.products.core }}, refer to [Release Support Policy]({% link releases/release-support-policy.md %}). For details on support per release type in CockroachDB Cloud, refer to [CockroachDB Cloud Support and Upgrade Policy]({% link cockroachcloud/upgrade-policy.md %}). +For details on how LTS impacts support in CockroachDB {{ site.data.products.core }}, refer to [Release Support Policy]({% link releases/release-support-policy.md %}). For details on support per release type in CockroachDB Cloud, refer to [CockroachDB Cloud Support and Upgrade Policy]({% link cockroachcloud/upgrade-policy.md %}). | Major Release Type | Frequency | Required upgrade | LTS releases and extended support | | :---: | :---: | :---: | :---: | -| Regular (e.g. v24.1) | 2x/year | on Dedicated, Serverless, Self-Hosted | Yes | -| Innovation (e.g. v24.2) | 2x/year | on Serverless only | No* | -* Column does not apply to CockroachDB Serverless, where clusters are automatically upgraded when a new major version or a patch release is available, ensuring continuous support. +| Regular (e.g. v24.1) | 2x/year | Yes | Yes | +| Innovation (e.g. v24.2) | 2x/year | on Basic only | No* | +* Column does not apply to CockroachDB Basic, where clusters are automatically upgraded when a new major version or a patch release is available, ensuring continuous support. -For a given CockroachDB {{ site.data.products.core }} or Dedicated cluster, customers may choose to exclusively install or upgrade to Regular Releases to benefit from longer testing and support lifecycles, or to also include Innovation Releases, and benefit from earlier access to new features. This choice does not apply to CockroachDB Serverless, where every major release is an automatic upgrade. +For a given CockroachDB {{ site.data.products.core }}, CockroachDB {{ site.data.products.standard }}, or CockroachDB {{ site.data.products.advanced }} cluster, customers may choose to exclusively install or upgrade to Regular Releases to benefit from longer testing and support lifecycles, or to also include Innovation Releases, and benefit from earlier access to new features. This choice does not apply to CockroachDB {{ site.data.products.basic }}, where every major release is an automatic upgrade. -CockroachDB v24.2 is an Innovation release and v24.3 is planned as a Regular release. Starting with v25.1, four major releases are expected per year, where every first and third release of the year is expected to be an Innovation release. For more details, refer to [Upcoming releases](#upcoming-releases). +CockroachDB v24.2 is an Innovation release and v24.3 is a Regular release. Starting with v25.1, four major releases are expected per year, where every first and third release of the year is expected to be an Innovation release. For more details, refer to [Upcoming releases](#upcoming-releases). #### Patch releases @@ -155,29 +155,29 @@ The following releases and their descriptions represent proposed plans that are 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.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 %} - {% elsif v.release_date != "N/A" and v.maint_supp_exp_date != "N/A" and v.asst_supp_exp_date == "N/A" %} - {% assign skippable = true %} + {% 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 }} -{% assign skippable = false %} -{% if v.release_date != "N/A" and v.maint_supp_exp_date != "N/A" and v.asst_supp_exp_date == "N/A" %} - {% assign skippable = true %} -{% endif %} - {% if DEBUG == true %} + released: {{ released }}
has_lts_releases: {{ has_lts_releases }}
lts_patch_string: {{ lts_patch_string }}
lts_patch: {{ lts_patch }}
@@ -189,7 +189,11 @@ The following releases and their descriptions represent proposed plans that are skippable: {{ skippable }}

{% endif %} -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.dedicated }} and CockroachDB {{ site.data.products.core }} but required for CockroachDB {{ site.data.products.serverless }}.{% 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 %}). +{% 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 %} @@ -204,7 +208,8 @@ Refer to [Major release types](#major-releases) before installing or upgrading f v.major_version == 'v21.1' or v.major_version == 'v21.2' or v.major_version == 'v22.1' or - v.major_version == 'v22.2' %} + 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 %}