Merge pull request #18322 from github/release-notes-upgrade-notice

GHES release notes upgrade notices

Author: sarahs

data/ui.yml

@@ -18,6 +18,10 @@ header:
       please visit our
       <a id="to-english-doc" href="/en">English documentation</a>.
     early_access: 📣 Please <b>do not share</b> this URL publicly. This page contains content about an early access feature.
+    ghes_release_notes_use_latest: Please use the latest release for the latest security, performance, and bug fixes.
+    ghes_release_notes_upgrade_patch_only: 📣 This is not the <a href="#{{ latestPatch }}">latest patch release</a> of Enterprise Server. {% data ui.header.notices.ghes_release_notes_use_latest %}
+    ghes_release_notes_upgrade_release_only: 📣 This is not the <a href="/enterprise-server@{{ latestRelease }}/admin/release-notes">latest release</a> of Enterprise Server. {% data ui.header.notices.ghes_release_notes_use_latest %}
+    ghes_release_notes_upgrade_patch_and_release: 📣 This is not the <a href="#{{ latestPatch }}">latest patch release</a> of this release series, and this is not the <a href="/enterprise-server@{{ latestRelease }}/admin/release-notes">latest release</a> of Enterprise Server. {% data ui.header.notices.ghes_release_notes_use_latest %}
 search:
   need_help: Need help?
   placeholder: Search topics, products...

layouts/release-notes.html

@@ -60,6 +60,18 @@ <h2 class="border-bottom-0 m-0 p-0">
                   </div>
 
                   <p class="text-gray mt-1">{{ patch.date | date: "%B %d, %Y" }}</p>
+
+                  {% if patch.version != latestPatch and allVersions[currentVersion].currentRelease == latestRelease %}
+                  <p class="text-gray mt-1">{% data ui.header.notices.ghes_release_notes_upgrade_patch_only %}</p>
+                  {% endif %}
+
+                  {% if patch.version == latestPatch and allVersions[currentVersion].currentRelease != latestRelease %}
+                  <p class="text-gray mt-1">{% data ui.header.notices.ghes_release_notes_upgrade_release_only %}</p>
+                  {% endif %}
+
+                  {% if patch.version != latestPatch and allVersions[currentVersion].currentRelease != latestRelease %}
+                  <p class="text-gray mt-1">{% data ui.header.notices.ghes_release_notes_upgrade_patch_and_release %}</p>
+                  {% endif %}
                 </header>
 
                 <div class="container-xl px-3">

middleware/contextualizers/enterprise-release-notes.js

@@ -1,7 +1,7 @@
 const semver = require('semver')
 const renderContent = require('../../lib/render-content')
 const patterns = require('../../lib/patterns')
-const enterpriseReleases = require('../../lib/enterprise-server-releases').supported
+const { supported, latest } = require('../../lib/enterprise-server-releases')
 
 /**
  * Turn { [key]: { notes, intro, date } }
@@ -92,7 +92,7 @@ module.exports = async function enterpriseReleaseNotesContext (req, res, next) {
   req.context.releaseNotes = await Promise.all(patches.map(async patch => renderPatchNotes(patch, req.context)))
 
   // Put together information about other releases
-  req.context.releases = enterpriseReleases.map(version => {
+  req.context.releases = supported.map(version => {
     const ret = { version }
     if (!req.context.site.data['release-notes']) return ret
     const release = req.context.site.data['release-notes'][version.replace(/\./g, '-')]
@@ -101,9 +101,12 @@ module.exports = async function enterpriseReleaseNotesContext (req, res, next) {
     return { ...ret, patches }
   })
 
-  const releaseIndex = enterpriseReleases.findIndex(release => release === requestedVersion)
-  req.context.nextRelease = enterpriseReleases[releaseIndex - 1]
-  req.context.prevRelease = enterpriseReleases[releaseIndex + 1]
+  const releaseIndex = supported.findIndex(release => release === requestedVersion)
+  req.context.nextRelease = supported[releaseIndex - 1]
+  req.context.prevRelease = supported[releaseIndex + 1]
+
+  req.context.latestPatch = patches[0].version
+  req.context.latestRelease = latest
 
   return next()
 }