Merge pull request #46368 from sftim/20240514_improve_patch_releases_page

Improve patch releases page

Author: k8s-ci-robot

assets/scss/_custom.scss

@@ -75,6 +75,10 @@ body {
  }
 }
 
+table td.value-not-applicable {
+ text-align: center;
+}
+
 /* Emphasize first paragraph of running text on site front page */
 body.td-home main[role="main"] > section:first-of-type .content p:first-child {
  line-height: 1.3em;

content/en/releases/patch-releases.md

@@ -59,7 +59,8 @@ Towards the end of the twelve month, the following will happen:
 During the two-month maintenance mode period, Release Managers may cut
 additional maintenance releases to resolve:
 
-- CVEs (under the advisement of the Security Response Committee)
+- [Vulnerabilities](/docs/reference/issues-security/official-cve-feed/) that have an assigned
+ CVE ID (under the advisement of the Security Response Committee)
 - dependency issues (including base image updates)
 - critical core component issues
 

data/i18n/en/en.toml

@@ -532,10 +532,13 @@ other = ")"
 other = "(released: "
 
 # See https://gohugo.io/functions/format/#gos-layout-string
-# Use a suitable format for your locale
+# Use a suitable format for your locale. Avoid using :date_short
 [release_date_format]
+# example: other = ":date_medium"
 other = "2006-01-02"
 
+# See https://gohugo.io/functions/format/#gos-layout-string
+# Use a suitable format for your locale.
 [release_date_format_month]
 other = "January 2006"
 
@@ -545,6 +548,17 @@ other = "Cherry Pick Deadline"
 [release_end_of_life_date]
 other = "End Of Life Date"
 
+# Also see release_maintenance_and_end_of_life_details_past
+[release_maintenance_and_end_of_life_details_current]
+other = "Kubernetes {{ .minor_version }} enters maintenance mode on {{ .maintenance_mode_start_date }}; the End of Life date for Kubernetes {{ .minor_version }} is {{ .release_eol_date }}."
+
+# Used if the maintenance mode date is in the past, otherwise
+# see release_maintenance_and_end_of_life_details_current
+[release_maintenance_and_end_of_life_details_past]
+other = """ℹ️ **Kubernetes {{ .minor_version }} entered maintenance mode on {{ .maintenance_mode_start_date }}**.
+
+The End of Life date for Kubernetes {{ .minor_version }} is {{ .release_eol_date }}."""
+
 [release_full_details_initial_text]
 other = "Complete"
 
@@ -557,16 +571,13 @@ other = "Minor Version"
 [release_info_next_patch]
 other = "Next patch release is **%s**."
 
-# Localization note: You can use Markdown here.
-# The three placeholders (in order) are:
-# Kubernetes minor version
-# maintenance mode date
-# end of life date
-#
-# Keep this order. It is OK to use more than one sentence, and it's also OK to change the
-# tense of the text so long as the meaning is clear.
+
+# Deprecated. Set release_maintenance_and_end_of_life_details_current
+# and release_maintenance_and_end_of_life_details_past instead.
+# OK to remove once all localizations have switched to the new strings.
 [release_info_eol]
-other = "**%s** enters maintenance mode on **%s** and End of Life is on **%s**."
+# Set this to "" if your localization implements the new strings.
+other = ""
 
 [release_note]
 other = "Note"

data/releases/eol.yaml

@@ -29,14 +29,6 @@ branches:
  note: 1.22.17 was released in December 2022 (after the EOL date) to backport registry
  changes and fix two critical issues.
  release: "1.22"
-- endOfLifeDate: "2022-11-09"
- finalPatchRelease: 1.22.16
- note: 1.22.16 was released in November 2022 (after the EOL date) to fix CVE-2022-3162
- and CVE-2022-3294.
- release: "1.22"
-- endOfLifeDate: "2022-10-28"
- finalPatchRelease: 1.22.15
- release: "1.22"
 - endOfLifeDate: "2022-06-28"
  finalPatchRelease: 1.21.14
  release: "1.21"
@@ -50,10 +42,6 @@ branches:
  finalPatchRelease: 1.18.20
  note: Created to solve regression introduced in 1.18.19
  release: "1.18"
-- endOfLifeDate: "2021-05-12"
- finalPatchRelease: 1.18.19
- note: '[Regression](https://groups.google.com/g/kubernetes-dev/c/KuF8s2zueFs)'
- release: "1.18"
 - endOfLifeDate: "2021-01-13"
  finalPatchRelease: 1.17.17
  release: "1.17"

data/releases/schedule.yaml

@@ -128,8 +128,7 @@ schedules:
  - cherryPickDeadline: "2023-09-08"
  release: 1.28.2
  targetDate: "2023-09-13"
- - cherryPickDeadline: N/A
- note: Unplanned release to include CVE fixes
+ - note: Unplanned release to include CVE fixes
  release: 1.28.1
  targetDate: "2023-08-23"
  - release: 1.28.0

layouts/shortcodes/eol-releases.html

@@ -18,7 +18,9 @@
  {{ $eolRelease.finalPatchRelease }}
  </td>
  <td>
- {{ $eolRelease.endOfLifeDate }}
+ {{- with $eolRelease.endOfLifeDate -}}
+ <time title="{{ time.Format ":date_long" . }}" datetime={{ time.Format "2006-01-02" . }}>{{ time.Format ( T "release_date_format" ) . }}</time>
+ {{- end -}}
  </td>
  <td lang="en-US">
  {{ $eolRelease.note | markdownify }}

layouts/shortcodes/release-branches.html

@@ -4,23 +4,41 @@
 
 <h3 id="{{ $dataIdVersion }}">{{ $version }}</h3>
 <p>
+ {{- if gt (time.Format "2006-01-02" $releaseInfo.maintenanceModeStartDate) (time.Format "2006-01-02" now) -}}
  {{ printf (T "release_info_next_patch") $releaseInfo.next.release | markdownify }}
+ {{- end -}}
 </p>
 <p>
  {{ $releaseInfo.next.note | markdownify }}
 </p>
 <p>
- {{ printf (T "release_info_eol")
+ {{- $maintenance_mode_start_date :=
+ ( printf "<time datetime=%s title=\"%s\">%s</time>"
+ (time.Format "2006-01-02" $releaseInfo.maintenanceModeStartDate)
+ (time.Format ":date_full" $releaseInfo.maintenanceModeStartDate)
+ (time.Format ":date_medium" $releaseInfo.maintenanceModeStartDate)
+ ) | safeHTML -}}
+ {{- $release_eol_date :=
+ ( printf "<time datetime=%s title=\"%s\">%s</time>"
+ (time.Format "2006-01-02" $releaseInfo.endOfLifeDate)
+ (time.Format ":date_full" $releaseInfo.endOfLifeDate)
+ (time.Format ":date_medium" $releaseInfo.endOfLifeDate)
+ ) | safeHTML -}}
+ {{- if eq (T "release_info_eol") "" -}}
+ {{- if gt (time.Format "2006-01-02" $releaseInfo.maintenanceModeStartDate) (time.Format "2006-01-02" now) -}}
+ {{- T "release_maintenance_and_end_of_life_details_current" (dict "minor_version" $version "maintenance_mode_start_date" $maintenance_mode_start_date "release_eol_date" $release_eol_date ) | markdownify -}}
+ {{- else -}}
+ {{- T "release_maintenance_and_end_of_life_details_past" (dict "minor_version" $version "maintenance_mode_start_date" $maintenance_mode_start_date "release_eol_date" $release_eol_date ) | markdownify -}}
+ {{- end -}}
+ {{- else -}}
+ <!-- use legacy localization approach -->
+ {{- printf (T "release_info_eol")
  $version
- ( printf "<time datetime=%s>%s</time>"
- (time.Format "2006-01-02" $releaseInfo.maintenanceModeStartDate)
- (time.Format ( T "release_date_format") $releaseInfo.maintenanceModeStartDate)
- )
- ( printf "<time datetime=%s>%s</time>"
- (time.Format "2006-01-02" $releaseInfo.endOfLifeDate)
- (time.Format ( T "release_date_format") $releaseInfo.endOfLifeDate)
- )
- | safeHTML | markdownify }}
+ $maintenance_mode_start_date
+ $release_eol_date
+ | markdownify -}}
+ {{- end -}}
+ </date>
 </p>
 {{ if $releaseInfo.previousPatches }}
 <div>
@@ -39,11 +57,21 @@ <h3 id="{{ $dataIdVersion }}">{{ $version }}</h3>
  <td>
  {{ $patchReleaseInfo.release }}
  </td>
+ {{- with $patchReleaseInfo.cherryPickDeadline -}}
  <td>
-  {{ $patchReleaseInfo.cherryPickDeadline }}
+ <time title="{{ time.Format ":date_full" . }}" datetime={{ time.Format "2006-01-02" . }}>{{ time.Format ( T "release_date_format" ) . }}</time>
  </td>
+ {{- else -}}
+ <td class="value-not-applicable">-</td>
+ {{- end -}}
+ {{- with $patchReleaseInfo.targetDate -}}
  <td>
- {{ $patchReleaseInfo.targetDate }}
+ <time title="{{ time.Format ":date_full" . }}" datetime={{ time.Format "2006-01-02" .}}>{{ time.Format ( T "release_date_format") . }}</time>
+ </time>
+ </td>
+ {{- else -}}
+ <td class="value-not-applicable">-</td>
+ {{- end -}}
  </td>
  <td lang="en-US">
  {{ $patchReleaseInfo.note | markdownify }}

layouts/shortcodes/upcoming-releases.html

@@ -12,13 +12,21 @@
  .Site.Data.releases.schedule.upcoming_releases }}
  <tr>
  <td>
- {{ time.Format ( T "release_date_format_month") $patchReleaseInfo.targetDate }}
+ {{- with $patchReleaseInfo.targetDate -}}
+ {{ time.Format ( T "release_date_format_month" ) . }}
+ {{- end -}}
  </td>
+ {{- with $patchReleaseInfo.cherryPickDeadline -}}
  <td>
- {{ time.Format ( T "release_date_format") $patchReleaseInfo.cherryPickDeadline }}
+ <time title="{{ time.Format ":date_full" . }}" datetime={{ time.Format "2006-01-02" . }}>{{ time.Format ":date_medium" . }}</time>
  </td>
+ {{- else -}}
+ <td class="value-not-applicable">-</td>
+ {{- end -}}
  <td>
- {{ time.Format ( T "release_date_format") $patchReleaseInfo.targetDate }}
+ {{- with $patchReleaseInfo.targetDate -}}
+ <time title="{{ time.Format ":date_full" . }}" datetime={{ time.Format "2006-01-02" . }}>{{ time.Format ":date_medium" . }}</time>
+ {{- end -}}
  </td>
  </tr>
  {{ end }}