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

package/README.adoc

@@ -287,7 +287,7 @@ To enable and configure the extension, add it to the `antora.extensions` section
 ----
 antora:
   extensions:
-    - require: '@redpanda-data/docs-extensions-and-macros/extensions/end-of-life'
+    - require: '@redpanda-data/docs-extensions-and-macros/extensions/compute-end-of-life'
       data:
         eol_settings:
           - component: 'ROOT'

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

@@ -0,0 +1,66 @@
+/**
+ * Fetches the latest version tag from Docker Hub for a given repository.
+ *
+ *
+ * @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.
+ */
+module.exports = async (dockerNamespace, dockerRepo) => {
+  const { default: fetch } = await import('node-fetch');
+
+  try {
+    // Fetch a list of tags from Docker Hub.
+    const url = `https://hub.docker.com/v2/repositories/${dockerNamespace}/${dockerRepo}/tags?page_size=100`;
+    const response = await fetch(url);
+
+    if (!response.ok) {
+      throw new Error(`Docker Hub API responded with status ${response.status}`);
+    }
+
+    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".
+    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));
+
+    // If the repository is "redpanda-operator", ignore any tags starting with the old "v22 or "v23" versions.
+    if (dockerRepo === 'redpanda-operator') {
+      versionTags = versionTags.filter(tag => !/^(v22|v23)/.test(tag.name));
+    }
+
+    if (versionTags.length === 0) {
+      console.warn('No version tags found.');
+      return null;
+    }
+
+    // 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) => {
+      const aMatch = a.name.match(versionRegex);
+      const bMatch = b.name.match(versionRegex);
+      const aMajor = parseInt(aMatch[1], 10);
+      const aMinor = parseInt(aMatch[2], 10);
+      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;
+    });
+
+    // Return the name of the tag with the highest major.minor version.
+    return versionTags[0].name;
+
+  } catch (error) {
+    console.error('Error fetching latest Docker tag:', error);
+    return null;
+  }
+};

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

@@ -3,7 +3,7 @@
 module.exports.register = function ({ config }) {
   const GetLatestRedpandaVersion = require('./get-latest-redpanda-version');
   const GetLatestConsoleVersion = require('./get-latest-console-version');
-  const GetLatestOperatorVersion = require('./get-latest-operator-version');
+  const GetLatestOperatorVersion = require('./fetch-latest-docker-tag');
   const GetLatestHelmChartVersion = require('./get-latest-redpanda-helm-version');
   const GetLatestConnectVersion = require('./get-latest-connect');
   const logger = this.getLogger('set-latest-version-extension');
@@ -25,6 +25,7 @@ module.exports.register = function ({ config }) {
       auth: process.env.REDPANDA_GITHUB_TOKEN || undefined,
     };
     const github = new OctokitWithRetries(githubOptions);
+    const dockerNamespace = 'redpandadata'
 
     try {
       const [
@@ -36,7 +37,7 @@ module.exports.register = function ({ config }) {
       ] = await Promise.allSettled([
         GetLatestRedpandaVersion(github, owner, 'redpanda'),
         GetLatestConsoleVersion(github, owner, 'console'),
-        GetLatestOperatorVersion(github, owner, 'redpanda-operator'),
+        GetLatestOperatorVersion(dockerNamespace, 'redpanda-operator'),
         GetLatestHelmChartVersion(github, owner, 'helm-charts', 'charts/redpanda/Chart.yaml'),
         GetLatestConnectVersion(github, owner, 'connect'),
       ]);
@@ -49,6 +50,8 @@ module.exports.register = function ({ config }) {
         connect: latestConnectResult.status === 'fulfilled' ? latestConnectResult.value : undefined,
       };
 
+      console.log(latestVersions)
+
       const components = await contentCatalog.getComponents();
       components.forEach(component => {
         const prerelease = component.latestPrerelease;
@@ -58,24 +61,25 @@ module.exports.register = function ({ config }) {
             asciidoc.attributes['page-component-version-is-prerelease'] = 'true';
           }
 
-          // Set operator and helm chart attributes
-          if (latestVersions.operator) {
-            asciidoc.attributes['latest-operator-version'] = latestVersions.operator;
-          }
-          if (latestVersions.helmChart) {
-            asciidoc.attributes['latest-redpanda-helm-chart-version'] = latestVersions.helmChart;
-          }
+          // Set operator and helm chart attributes via helper function
+          updateAttributes(asciidoc, [
+            { condition: latestVersions.operator, key: 'latest-operator-version', value: latestVersions.operator },
+            { condition: latestVersions.helmChart, key: 'latest-redpanda-helm-chart-version', value: latestVersions.helmChart }
+          ]);
 
           // Set attributes for console and connect versions
-          if (latestVersions.console) {
-            setVersionAndTagAttributes(asciidoc, 'latest-console', latestVersions.console.latestStableRelease, name, version);
-          }
-          if (latestVersions.connect) {
-            setVersionAndTagAttributes(asciidoc, 'latest-connect', latestVersions.connect, name, version);
-          }
+          [
+            { condition: latestVersions.console, baseName: 'latest-console', value: latestVersions.console?.latestStableRelease },
+            { condition: latestVersions.connect, baseName: 'latest-connect', value: latestVersions.connect }
+          ].forEach(mapping => {
+            if (mapping.condition && mapping.value) {
+              setVersionAndTagAttributes(asciidoc, mapping.baseName, mapping.value, name, version);
+            }
+          });
+
           // 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, '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;
           }
@@ -127,4 +131,13 @@ module.exports.register = function ({ config }) {
   function sanitizeVersion(version) {
     return version.replace(/^v/, '');
   }
-};
+
+  // Helper function to update multiple attributes based on a list of mappings
+  function updateAttributes(asciidoc, mappings) {
+    mappings.forEach(({ condition, key, value }) => {
+      if (condition) {
+        asciidoc.attributes[key] = value;
+      }
+    });
+  }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redpanda-data/docs-extensions-and-macros",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Antora extensions and macros developed for Redpanda documentation.",
   "keywords": [
     "antora",
@@ -75,6 +75,7 @@
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "micromatch": "^4.0.8",
+    "node-fetch": "^3.3.2",
     "node-html-parser": "5.4.2-0",
     "papaparse": "^5.4.1",
     "semver": "^7.6.0",

package/extensions/version-fetcher/get-latest-operator-version.js

@@ -1,10 +0,0 @@
-module.exports = async (github, owner, repo) => {
-  try {
-    const release = await github.rest.repos.getLatestRelease({ owner, repo });
-    latestOperatorReleaseVersion = release.data.tag_name;
-    return latestOperatorReleaseVersion;
-  } catch (error) {
-    console.error(error);
-    return null;
-  }
-};