Fix display issues with Testing releases on What's New and Releases index #19016
Conversation
Files changed:
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
| {% if include.major_version.release_date != "N/A" %} | ||
| {% assign released = true %} |
There was a problem hiding this comment.
This date is pulled from versions.csv right? Wouldn't this require us to ensure we leave the release date as "N/A" there until the GA PR, i.e. not include the future planned GA date when we create the row or on alpha.1? (That could be our policy, but it's hard to enforce/test.)
Should we instead determine whether a major version is GA-released based on a test of whether releases.yaml has a release_name value of <major_version>.0?
Your code works as written with the above caveat, so I'm happy to have you merge and I can raise an issue for possible iteration, if you don't fully support making that change now (due to complexity / lack of urgency / etc).
| {% 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" %} |
There was a problem hiding this comment.
I think this might have the same issue/question with checking release_date for "N/A" that I mentioned in my other comment, but I'm not sure why maint_supp_exp_date is included here. (Isn't it redundant; we expect that for any GA release, we'd have both?) (Moot point if we were to switch the logic to look at releases.yaml, of course, but I am assume we won't do that right now.)
| @@ -189,7 +189,11 @@ The following releases and their descriptions represent proposed plans that are | |||
| skippable: {{ skippable }}<br /><br /> | |||
| {% 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. | |||
There was a problem hiding this comment.
| 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. | |
| CockroachDB {{ page.major_version }} is in active development and is not yet supported. The following [testing releases]({% link releases/index.md %}#patch-releases) 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. |
There's a lot for the reader to get through in the subheading Release types > Major releases which is not really relevant, so I figure it's better to link directly to Release types > Patch releases, which has the definitions of Production and Testing releases.
Testing
Previews
releases/index.md#v24.3
src/current/releases/v24.3.md
Should show no change to output:
releases/index.md#v24.2
releases/index.md#v24.1
releases/index.md#v23.2
releases/index.md#v23.1
releases/index.md#v23.1
src/current/releases/v24.2.md
src/current/releases/v24.1.md
src/current/releases/v23.2.md
src/current/releases/v23.1.md
src/current/releases/v22.2.md