@redpanda-data/docs-extensions-and-macros 4.2.0 → 4.2.1

package/extensions/version-fetcher/fetch-latest-docker-tag.js

@@ -1,10 +1,12 @@
 /**
- * Fetches the latest version tag from Docker Hub for a given repository.
+ * Fetches the latest stable and beta version tags from Docker Hub for a given repository.
  *
+ * The function separates tags into stable (tags not including "-beta") and beta (tags including "-beta"),
+ * sorts each group by their major.minor version in descending order, and returns the top tag from each.
  *
  * @param {string} dockerNamespace - The Docker Hub namespace (organization or username)
  * @param {string} dockerRepo - The repository name on Docker Hub
- * @returns {Promise<string|null>} The latest version tag or null if none is found.
+ * @returns {Promise<{ latestStableRelease: string|null, latestBetaRelease: string|null }>}
  */
 module.exports = async (dockerNamespace, dockerRepo) => {
   const { default: fetch } = await import('node-fetch');
@@ -20,28 +22,23 @@ module.exports = async (dockerNamespace, dockerRepo) => {
 
     const data = await response.json();
 
-    // Define a regular expression to capture the major and minor version numbers.
-    // The regex /^v(\d+)\.(\d+)/ matches tags that start with "v", followed by digits (major),
-    // a period, and more digits (minor). It works for tags like "v2.3.8-24.3.6" or "v25.1-k8s4".
+    // Regex to capture major and minor version numbers (e.g. "v2.3")
     const versionRegex = /^v(\d+)\.(\d+)/;
 
-    // Filter the list of tags to include only those that match our expected version pattern.
-    // This helps ensure we work only with tags that represent valid version numbers.
-    let versionTags = data.results.filter(tag => versionRegex.test(tag.name));
+    // Filter tags to include only those matching the version pattern.
+    let tags = data.results.filter(tag => versionRegex.test(tag.name));
 
-    // If the repository is "redpanda-operator", ignore any tags starting with the old "v22 or "v23" versions.
+    // For specific repositories (e.g. "redpanda-operator"), you might want to filter out certain versions.
     if (dockerRepo === 'redpanda-operator') {
-      versionTags = versionTags.filter(tag => !/^(v22|v23)/.test(tag.name));
+      tags = tags.filter(tag => !/^(v22|v23)/.test(tag.name));
     }
 
-    if (versionTags.length === 0) {
-      console.warn('No version tags found.');
-      return null;
-    }
+    // Separate stable and beta tags.
+    const stableTags = tags.filter(tag => !tag.name.includes('-beta'));
+    const betaTags = tags.filter(tag => tag.name.includes('-beta'));
 
-    // Sort the filtered tags in descending order based on their major and minor version numbers.
-    // This sorting ignores any additional patch or suffix details and focuses only on the major.minor value.
-    versionTags.sort((a, b) => {
+    // Helper function to sort tags in descending order based on major and minor version numbers.
+    const sortTags = (a, b) => {
       const aMatch = a.name.match(versionRegex);
       const bMatch = b.name.match(versionRegex);
       const aMajor = parseInt(aMatch[1], 10);
@@ -49,18 +46,28 @@ module.exports = async (dockerNamespace, dockerRepo) => {
       const bMajor = parseInt(bMatch[1], 10);
       const bMinor = parseInt(bMatch[2], 10);
 
-      // Compare by major version first; if equal, compare by minor version.
       if (aMajor !== bMajor) {
         return bMajor - aMajor;
       }
       return bMinor - aMinor;
-    });
+    };
+
+    const sortedStable = stableTags.sort(sortTags);
+    const sortedBeta = betaTags.sort(sortTags);
+
+    const latestStableReleaseVersion = sortedStable.length ? sortedStable[0].name : null;
+    const latestBetaReleaseVersion = sortedBeta.length ? sortedBeta[0].name : null;
 
-    // Return the name of the tag with the highest major.minor version.
-    return versionTags[0].name;
+    return {
+      latestStableRelease: latestStableReleaseVersion || null,
+      latestBetaRelease: latestBetaReleaseVersion || null
+    };
 
   } catch (error) {
-    console.error('Error fetching latest Docker tag:', error);
-    return null;
+    console.error('Error fetching Docker tags:', error);
+    return {
+      latestStableRelease: null,
+      latestBetaRelease: null
+    };
   }
 };

package/extensions/version-fetcher/set-latest-version.js

@@ -63,7 +63,7 @@ module.exports.register = function ({ config }) {
 
           // Set operator and helm chart attributes via helper function
           updateAttributes(asciidoc, [
-            { condition: latestVersions.operator, key: 'latest-operator-version', value: latestVersions.operator },
+            { condition: latestVersions.operator, key: 'latest-operator-version', value: latestVersions.operator?.latestStableRelease },
             { condition: latestVersions.helmChart, key: 'latest-redpanda-helm-chart-version', value: latestVersions.helmChart }
           ]);
 
@@ -80,9 +80,14 @@ module.exports.register = function ({ config }) {
           // Special handling for Redpanda RC versions if in beta
           if (latestVersions.redpanda?.latestRcRelease?.version) {
             setVersionAndTagAttributes(asciidoc, 'redpanda-beta', latestVersions.redpanda.latestRcRelease.version, name, version);
-            setVersionAndTagAttributes(asciidoc, 'console-beta', latestVersions.console.latestBetaRelease, name, version);
             asciidoc.attributes['redpanda-beta-commit'] = latestVersions.redpanda.latestRcRelease.commitHash;
           }
+          if (latestVersions.console?.latestBetaRelease) {
+            setVersionAndTagAttributes(asciidoc, 'console-beta', latestVersions.console.latestBetaRelease, name, version);
+          }
+          if (latestVersions.operator?.latestBetaRelease) {
+            setVersionAndTagAttributes(asciidoc, 'operator-beta', latestVersions.operator.latestBetaRelease, name, version);
+          }
         });
 
         if (!component.latest.asciidoc) component.latest.asciidoc = { attributes: {} };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redpanda-data/docs-extensions-and-macros",
-  "version": "4.2.0",
+  "version": "4.2.1",
   "description": "Antora extensions and macros developed for Redpanda documentation.",
   "keywords": [
     "antora",