Merge pull request #1843 from rabbitmq/more-improvements-to-release-info

More improvements to release information

Author: dumbbell

docusaurus.config.js

@@ -39,53 +39,62 @@ const config = {
   },
 
   customFields: {
-    releases: {
+    releaseBranches: {
       rabbitmq: {
         // RabbitMQ releases per version declared in Docusaurus ('Next' for the
         // future docs).
         'Next': {
-          //version: '3.13.0',
           // package_revs: {
           //   'debian': '1',
           //   'rpm-el8': '1',
           //   'rpm-suse': '1',
           // }
         },
         '3.13': {
-          version: '3.13.0',
-          links: [
+          releases: [
             {
-              label: "Annoucement",
-              url: "/blog/2024/03/11/rabbitmq-3.13.0-announcement"
+              version: '3.13.0',
+              release_date: "2024-02-22",
+              links: [
+                {
+                  label: "Announcement",
+                  url: "/blog/2024/03/11/rabbitmq-3.13.0-announcement"
+                },
+              ],
             },
           ],
-          first_release: "2024-02-22",
           end_of_community_support: "2025-03-01",
           end_of_commercial_support: "2025-09-01",
         },
         '3.12': {
-          version: '3.12.13',
-          first_release: "2023-06-02",
+          releases: [
+            {version: '3.12.13', release_date: "2024-02-16", },
+            {version: '3.12.0', release_date: "2023-06-02", },
+          ],
           end_of_community_support: "2024-06-30",
           end_of_commercial_support: "2024-12-31",
         },
         '3.11': {
-          version: '3.11.28',
-          first_release: "2022-09-28",
+          releases: [
+            {version: '3.11.28', release_date: "2023-12-22", },
+            {version: '3.11.0', release_date: "2022-09-28", },
+          ],
           end_of_community_support: "2023-12-31",
           end_of_commercial_support: "2024-07-31",
         },
         '3.10': {
-          version: '3.10.25',
-          first_release: "2022-05-03",
+          releases: [
+            {version: '3.10.25', release_date: "2023-07-18", },
+            {version: '3.10.0', release_date: "2022-05-03", },
+          ],
           end_of_community_support: "2022-05-03",
           end_of_commercial_support: "2023-12-31",
         },
       },
 
       // Client releases.
       java: '5.20.0',
-      dotnot: '6.6.0',
+      dotnet: '6.6.0',
     },
   },
 

release-information/index.md

@@ -34,7 +34,9 @@ the release notes of the target release.
 
 <RabbitMQServerReleaseInfoTable/>
 
+:::note
 Older releases that are not in this table are unsupported.
+:::
 
 ## Support Policy {#support-policy}
 

src/components/DotNetClient/index.js

@@ -5,11 +5,11 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 function getActualVersion() {
   const {
     siteConfig: {
-      customFields: {releases},
+      customFields: {releaseBranches},
     },
   } = useDocusaurusContext();
 
-  const version = releases['dotnet'];
+  const version = releaseBranches['dotnet'];
   return version;
 }
 

src/components/JavaClient/index.js

@@ -5,11 +5,11 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 function getActualVersion() {
   const {
     siteConfig: {
-      customFields: {releases},
+      customFields: {releaseBranches},
     },
   } = useDocusaurusContext();
 
-  const version = releases['java'];
+  const version = releaseBranches['java'];
   return version;
 }
 

src/components/RabbitMQServer/index.js

@@ -1,6 +1,6 @@
 import React from 'react';
 
-import { getReleaseInfo } from '@site/src/components/RabbitMQServerReleaseInfo';
+import { getLatestRelease, getLatestVersion } from '@site/src/components/RabbitMQServerReleaseInfo';
 import { useActiveVersion } from '@docusaurus/plugin-content-docs/client';
 
 function getBranchOrDefault({ branch } = { branch: undefined }) {
@@ -11,23 +11,20 @@ function getBranchOrDefault({ branch } = { branch: undefined }) {
   return branch;
 }
 
-function getActualVersion(props) {
-  const releases = getReleaseInfo();
+function getLatestVersionForCurrentBranch(props) {
   const branch = getBranchOrDefault(props);
-
-  const version = releases[branch].version;
+  const version = getLatestVersion(branch);
   return version;
 }
 
 function getPackageRevision(props) {
-  const releases = getReleaseInfo();
   const branch = getBranchOrDefault(props);
+  const release = getLatestRelease(branch);
+  const { packageType } = props;
 
   var package_rev;
-  if ('package_revs' in releases[branch] &&
-    packageType in releases[branch]['package_revs']) {
-    const { packageType } = props;
-    package_rev = releases[branch]['package_revs'][packageType];
+  if ('package_revs' in release && packageType in release['package_revs']) {
+    package_rev = release['package_revs'][packageType];
   } else {
     package_rev = '1';
   }
@@ -40,19 +37,19 @@ export function RabbitMQServerProductName() {
 }
 
 export function RabbitMQServerVersion(props = {}) {
-  const version = getActualVersion(props);
+  const version = getLatestVersionForCurrentBranch(props);
   return version;
 }
 
 export function RabbitMQServerGitTag(props = {}) {
-  const version = getActualVersion(props);
+  const version = getLatestVersionForCurrentBranch(props);
   const tag = `v${version}`;
   return tag;
 }
 
 export function RabbitMQServerPackageURL(props) {
   const { packageType } = props;
-  const version = getActualVersion(props);
+  const version = getLatestVersionForCurrentBranch(props);
   const tag = RabbitMQServerGitTag();
   const baseUrl = `https://github.com/rabbitmq/rabbitmq-server/releases/download/${tag}`;
   switch (packageType) {
@@ -100,7 +97,7 @@ export function RabbitMQServerPackageFilename(props) {
 }
 
 export function RabbitMQServerPackageGenUnixDir(props = {}) {
-  const version = getActualVersion(props);
+  const version = getLatestVersionForCurrentBranch(props);
   const dir = `rabbitmq_${version}`;
   return dir;
 }

src/components/RabbitMQServerReleaseInfo/index.js

@@ -2,46 +2,65 @@ import React from 'react';
 
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 
-export function getReleaseInfo() {
+export function getReleaseBranches() {
   const {
     siteConfig: {
       customFields: {
-        releases: {
-          rabbitmq: releases
+        releaseBranches: {
+          rabbitmq: releaseBranches
         },
       },
     },
   } = useDocusaurusContext();
 
-  return releases;
+  return releaseBranches;
+}
+
+export function getReleaseBranch(branch) {
+  const releaseBranches = getReleaseBranches();
+  const releaseBranch = releaseBranches[branch];
+  return releaseBranch;
+}
+
+export function getLatestRelease(branch) {
+  const releaseBranch = getReleaseBranch(branch);
+  const release = releaseBranch.releases[0];
+  return release;
+}
+
+export function getLatestVersion(branch) {
+  const release = getLatestRelease(branch);
+  return release.version;
 }
 
 export function RabbitMQServerReleaseInfoTable() {
-  const releases = getReleaseInfo();
+  const releaseBranches = getReleaseBranches();
 
   const now = Date.now();
   const dateOptions = { year: 'numeric', month: 'short', day: 'numeric' };
 
   var sawLatestRelease = false;
 
   var rows = [];
-  for (const series in releases) {
-    if (series == 'Next') {
+  for (const branch in releaseBranches) {
+    if (branch == 'Next') {
       continue;
     }
 
-    const release = releases[series];
+    const releaseBranch = releaseBranches[branch];
+    const releases = releaseBranch.releases;
+    const lastRelease = releases[0];
 
-    const isReleased = typeof release.first_release !== 'undefined';
+    const isReleased = typeof lastRelease.release_date !== 'undefined';
 
     var links;
     if (isReleased) {
       links = [{
         label: "Release Notes",
-        url: `https://github.com/rabbitmq/rabbitmq-server/releases/tag/v${release.version}`
+        url: `https://github.com/rabbitmq/rabbitmq-server/releases/tag/v${lastRelease.version}`
       }];
-      if (release.links) {
-        links = links.concat(release.links);
+      if (lastRelease.links) {
+        links = links.concat(lastRelease.links);
       }
 
       links = (
@@ -56,20 +75,21 @@ export function RabbitMQServerReleaseInfoTable() {
       links = <></>
     }
 
+    const initialRelease = releases[releases.length - 1];
     var initialReleaseDate;
-    if (release.first_release) {
-      const date = new Date(release.first_release);
+    if (initialRelease.release_date) {
+      const date = new Date(initialRelease.release_date);
       initialReleaseDate = date.toLocaleDateString("en-GB", dateOptions);
     } else {
       initialReleaseDate = <></>;
     }
 
     var endOfSupportDates = [];
-    if (release.end_of_community_support) {
-      endOfSupportDates.push(release.end_of_community_support);
+    if (releaseBranch.end_of_community_support) {
+      endOfSupportDates.push(releaseBranch.end_of_community_support);
     }
-    if (release.end_of_commercial_support) {
-      endOfSupportDates.push(release.end_of_commercial_support);
+    if (releaseBranch.end_of_commercial_support) {
+      endOfSupportDates.push(releaseBranch.end_of_commercial_support);
     }
 
     endOfSupportDates = endOfSupportDates.map(function(rawDate) {
@@ -100,8 +120,8 @@ export function RabbitMQServerReleaseInfoTable() {
 
     rows.push(
       <tr className={latestReleaseClass}>
-        <td class="release-series">{series}</td>
-        <td class="release-patch">{release.version || "-"}</td>
+        <td class="release-branch">{branch}</td>
+        <td class="release-version">{lastRelease.version || "-"}</td>
         <td class="release-links">{links}</td>
         <td class="release-date">{initialReleaseDate}</td>
         {endOfSupportDates}
@@ -113,27 +133,23 @@ export function RabbitMQServerReleaseInfoTable() {
     <div className="release-information">
       <table>
         <tr>
-          <th rowspan="2">Ver.</th>
-          <th rowspan="2">Latest Rel.</th>
-          <th rowspan="2">Links</th>
-          <th rowspan="2">Initial Release</th>
-          <th colspan="2">End of Support</th>
-        </tr>
-        <tr>
-          <th>Community</th>
-          <th>Ext. Commercial</th>
+          <th>Release</th>
+          <th colspan="2">Latest Patch</th>
+          <th>Date of First Release</th>
+          <th>End of Community Support</th>
+          <th>End of Extended Commercial Support</th>
         </tr>
-        <tr></tr>
 
         {rows}
 
       </table>
-      <p><strong>Legend:</strong></p>
-      <ul className="release-legend">
-        <li className="supported-releaase latest-release">Latest release, fully supported</li>
-        <li className="supported-release">Older release, still supported but upgrade is recommended</li>
-        <li className="unsupported-release">Old release, unsupported</li>
-        {/*<li className="unsupported-release future-release">Future version, unsupported</li>*/}
-      </ul>
+
+      <strong>Legend:</strong>
+      <dl className="release-legend">
+        <dt className="supported-releaase latest-release"></dt><dd>Latest release, fully supported</dd>
+        <dt className="supported-release"></dt><dd>Older release, still supported but upgrade is recommended</dd>
+        <dt className="unsupported-release"></dt><dd>Old release, unsupported</dd>
+        {/*<dt className="unsupported-release future-release"></dt><dd>Future version, unsupported</dd>*/}
+      </dl>
     </div>);
 }