@redpanda-data/docs-extensions-and-macros 4.6.3 → 4.6.5

package/bin/doc-tools.js

@@ -485,7 +485,16 @@ automation
   .option('--template-examples <path>', 'Examples section partial template', path.resolve(__dirname, '../tools/redpanda-connect/templates/examples-partials.hbs'))
   .option('--overrides <path>', 'Optional JSON file with overrides')
   .action(async (options) => {
-    let success = true;
+    requireTool('rpk', {
+      versionFlag: '--version',
+      help: 'rpk is not installed. Install rpk: https://docs.redpanda.com/current/get-started/rpk-install/'
+    });
+
+    requireTool('rpk connect', {
+      versionFlag: '--version',
+      help: 'rpk connect is not installed. Run rpk connect install before continuing.'
+    });
+
     const dataDir = path.resolve(process.cwd(), options.dataDir);
     fs.mkdirSync(dataDir, { recursive: true });
 
@@ -495,7 +504,6 @@ automation
     let dataFile;
     if (options.fetchConnectors) {
       try {
-        execSync('rpk --version', { stdio: 'ignore' });
         newVersion = getRpkConnectVersion();
         const tmpFile = path.join(dataDir, `connect-${newVersion}.tmp.json`);
         const finalFile = path.join(dataDir, `connect-${newVersion}.json`);
@@ -512,7 +520,7 @@ automation
         console.log(`✅ Fetched and saved: ${finalFile}`);
       } catch (err) {
         console.error(`❌ Failed to fetch connectors: ${err.message}`);
-        success = false;
+        process.exit(1);
       }
     } else {
       const candidates = fs.readdirSync(dataDir).filter(f => /^connect-\d+\.\d+\.\d+\.json$/.test(f));
@@ -542,7 +550,7 @@ automation
       partialFiles    = result.partialFiles;
     } catch (err) {
       console.error(`❌ Failed to generate partials: ${err.message}`);
-      success = false;
+      process.exit(1);
     }
 
     if (options.draftMissing) {
@@ -613,7 +621,7 @@ automation
         }
       } catch (err) {
         console.error(`❌ Could not draft missing: ${err.message}`);
-        success = false;
+        process.exit(1);
       }
     }
 
@@ -667,8 +675,7 @@ automation
     console.log('\n📄 Summary:');
     console.log(`   • Run time: ${timestamp}`);
     console.log(`   • Version used: ${newVersion}`);
-
-    process.exit(success ? 0 : 1);
+    process.exit(0);
   });
 
 automation

package/extensions/version-fetcher/get-latest-redpanda-helm-version-from-operator.js

@@ -0,0 +1,84 @@
+/**
+ * Fetches the latest Helm chart version from the redpanda-operator repository
+ * by converting docker tag format v<major>.<minor>.<patch> to release/v<major>.<minor>.x
+ * and checking the Chart.yaml file in that branch.
+ *
+ * @param {object} github - The GitHub API client.
+ * @param {string} owner - The repository owner.
+ * @param {string} repo - The repository name (redpanda-operator).
+ * @param {string} stableDockerTag - The stable docker tag in format v<major>.<minor>.<patch>.
+ * @param {string} betaDockerTag - Optional beta docker tag in format v<major>.<minor>.<patch>-beta.
+ * @returns {Promise<{ latestStableRelease: string|null, latestBetaRelease: string|null }>}
+ */
+module.exports = async (github, owner, repo, stableDockerTag, betaDockerTag) => {
+  const yaml = require('js-yaml');
+  const path = 'charts/redpanda/Chart.yaml';
+
+  /**
+   * Helper function to fetch chart version from a branch derived from a docker tag
+   * @param {string} dockerTag - The docker tag to derive branch from
+   * @returns {Promise<string|null>} - The chart version or null if not found
+   */
+  const getChartVersionFromTag = async (dockerTag) => {
+    if (!dockerTag) return null;
+
+    try {
+
+      // Parse the docker tag to extract major and minor versions
+      // Support both v2.4.2 format and v25.1.3 format
+      const versionMatch = dockerTag.match(/^v(\d+)\.(\d+)(?:\.(\d+))?(?:-beta.*)?$/);
+
+      if (!versionMatch) {
+        console.error(`Invalid docker tag format: ${dockerTag}`);
+        return null;
+      }
+
+      const major = versionMatch[1];
+      const minor = versionMatch[2];
+
+      // Convert to release/v<major>.<minor>.x format
+      const branchName = `release/v${major}.${minor}.x`;
+
+      try {
+
+        // Fetch Chart.yaml from the specified branch
+        const contentResponse = await github.repos.getContent({
+          owner,
+          repo,
+          path,
+          ref: branchName,
+        });
+
+        const contentBase64 = contentResponse.data.content;
+        const contentDecoded = Buffer.from(contentBase64, 'base64').toString('utf8');
+        const chartYaml = yaml.load(contentDecoded);
+        const version = chartYaml.version || null;
+        return version;
+      } catch (error) {
+        console.error(`Failed to fetch Chart.yaml for branch ${branchName}:`, error.message);
+        return null;
+      }
+    } catch (error) {
+      console.error(`Error processing docker tag ${dockerTag}:`, error.message);
+      return null;
+    }
+  };
+  try {
+    // Get chart versions for both stable and beta tags in parallel
+    const [stableChartVersion, betaChartVersion] = await Promise.all([
+      getChartVersionFromTag(stableDockerTag),
+      getChartVersionFromTag(betaDockerTag)
+    ]);
+
+    return {
+      latestStableRelease: stableChartVersion,
+      latestBetaRelease: betaChartVersion
+    };
+  } catch (error) {
+    console.error('Failed to fetch chart versions:', error.message);
+    return {
+      latestStableRelease: null,
+      latestBetaRelease: null
+    };
+  }
+};

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

@@ -4,7 +4,7 @@ module.exports.register = function ({ config }) {
   const GetLatestRedpandaVersion = require('./get-latest-redpanda-version');
   const GetLatestConsoleVersion = require('./get-latest-console-version');
   const GetLatestDockerTag = require('./fetch-latest-docker-tag');
-  const GetLatestHelmChartVersion = require('./get-latest-redpanda-helm-version');
+  const GetLatestHelmChartVersionFromOperator = require('./get-latest-redpanda-helm-version-from-operator');
   const GetLatestConnectVersion = require('./get-latest-connect');
   const logger = this.getLogger('set-latest-version-extension');
 
@@ -32,15 +32,41 @@ module.exports.register = function ({ config }) {
         latestRedpandaResult,
         latestConsoleResult,
         latestOperatorResult,
-        latestHelmChartResult,
         latestConnectResult,
       ] = await Promise.allSettled([
         GetLatestRedpandaVersion(github, owner, 'redpanda'),
         GetLatestDockerTag(dockerNamespace, 'console'),
         GetLatestDockerTag(dockerNamespace, 'redpanda-operator'),
-        GetLatestHelmChartVersion(github, owner, 'helm-charts', 'charts/redpanda/Chart.yaml'),
         GetLatestConnectVersion(github, owner, 'connect'),
       ]);
+      
+      // Get the Helm chart version after we have the operator version (for both stable and beta)
+      let latestHelmChartResult = { status: 'rejected', reason: 'Operator result not fulfilled' };
+      
+      if (latestOperatorResult.status === 'fulfilled') {
+        try {
+          const helmChartVersions = await GetLatestHelmChartVersionFromOperator(
+            github, 
+            owner, 
+            'redpanda-operator', 
+            latestOperatorResult.value?.latestStableRelease,
+            latestOperatorResult.value?.latestBetaRelease
+          );
+          
+          latestHelmChartResult = { 
+            status: 'fulfilled', 
+            value: helmChartVersions 
+          };
+        } catch (error) {
+          latestHelmChartResult = { 
+            status: 'rejected', 
+            reason: error.message || 'Unknown error fetching Helm chart version'
+          };
+          logger.error(`Helm chart lookup failed: ${error.message || error}`);
+        }
+      } else {
+        logger.error(`Helm chart lookup failed: Operator version not available`);
+      }
 
       const latestVersions = {
         redpanda: latestRedpandaResult.status === 'fulfilled' ? latestRedpandaResult.value : {},
@@ -105,14 +131,12 @@ module.exports.register = function ({ config }) {
         }
       });
 
-      logger.info('Updated Redpanda documentation versions successfully.');
-      logger.info(`Latest Redpanda version: ${latestVersions.redpanda.latestRedpandaRelease.version}`);
-      if (latestVersions.redpanda.latestRCRelease) logger.info(`Latest Redpanda beta version: ${latestVersions.redpanda.latestRCRelease.version}`);
-      logger.info(`Latest Connect version: ${latestVersions.connect}`);
-      logger.info(`Latest Console version: ${latestVersions.console.latestStableRelease}`);
-      if (latestVersions.console.latestBetaRelease) logger.info(`Latest Console beta version: ${latestVersions.console.latestBetaRelease}`);
-      logger.info(`Latest Redpanda Helm chart version: ${latestVersions.helmChart}`);
-      logger.info(`Latest Operator version: ${latestVersions.operator}`);
+      logger.info('Updated Redpanda documentation versions successfully:');
+      logger.info(`- Redpanda: ${latestVersions.redpanda.latestRedpandaRelease.version}${latestVersions.redpanda.latestRcRelease ? ', beta: ' + latestVersions.redpanda.latestRcRelease.version : ''}`);
+      logger.info(`- Connect: ${latestVersions.connect}`);
+      logger.info(`- Console: ${latestVersions.console.latestStableRelease}${latestVersions.console.latestBetaRelease ? ', beta: ' + latestVersions.console.latestBetaRelease : ''}`);
+      logger.info(`- Operator: ${latestVersions.operator?.latestStableRelease || 'unknown'}${latestVersions.operator?.latestBetaRelease ? ', beta: ' + latestVersions.operator.latestBetaRelease : ''}`);
+      logger.info(`- Helm chart: ${latestVersions.helmChart?.latestStableRelease || 'unknown'}${latestVersions.helmChart?.latestBetaRelease ? ', beta: ' + latestVersions.helmChart.latestBetaRelease : ''}`);
     } catch (error) {
       logger.error(`Error updating versions: ${error}`);
     }

package/package.json

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

package/extensions/version-fetcher/get-latest-redpanda-helm-version.js

@@ -1,122 +0,0 @@
-/**
- * Fetches the latest Helm chart version from GitHub releases.
- *
- * This function looks for releases with tags following these patterns:
- *   - Stable: "redpanda-5.9.21" or "25.1-k8s4" (without "beta" anywhere)
- *   - Beta: "redpanda-5.9.21-beta", "redpanda-5.9.21-beta.1", or "25.1-k8s4-beta"
- *
- * It selects the highest version for each category, fetches the file at the provided path
- * (typically Chart.yaml) using the tag as the Git ref, parses it, and returns an object with
- * the chart version from the highest stable release and the highest beta release.
- *
- * @param {object} github - The GitHub API client.
- * @param {string} owner - The repository owner.
- * @param {string} repo - The repository name.
- * @param {string} path - The path to the Chart.yaml file in the repository.
- * @returns {Promise<{ latestStableRelease: string|null, latestBetaRelease: string|null }>}
- */
-module.exports = async (github, owner, repo, path) => {
-  const yaml = require('js-yaml');
-  try {
-    // Fetch up to 20 releases from GitHub.
-    const releasesResponse = await github.repos.listReleases({
-      owner,
-      repo,
-      per_page: 20,
-    });
-    const releases = releasesResponse.data;
-
-    // Regex patterns:
-    // Stable regex: "redpanda-" prefix, then major.minor with an optional patch,
-    // and no "beta" anywhere in the tag.
-    const stableRegex = /^(?:redpanda-)(\d+)\.(\d+)(?:\.(\d+))?(?!.*beta)/i;
-    // Beta regex: "redpanda-" prefix, then major.minor with an optional patch,
-    // and later somewhere "beta" with an optional numeric qualifier.
-    const betaRegex = /^(?:redpanda-)(\d+)\.(\d+)(?:\.(\d+))?.*beta(?:\.(\d+))?$/i;
-
-    // Filter releases into stable and beta arrays based on tag matching.
-    const stableReleases = releases.filter(release => stableRegex.test(release.tag_name));
-    const betaReleases = releases.filter(release => betaRegex.test(release.tag_name));
-
-    // Sorting function for stable releases.
-    const sortStable = (a, b) => {
-      const aMatch = a.tag_name.match(stableRegex);
-      const bMatch = b.tag_name.match(stableRegex);
-      if (!aMatch || !bMatch) return 0;
-      const aMajor = parseInt(aMatch[1], 10);
-      const aMinor = parseInt(aMatch[2], 10);
-      const aPatch = aMatch[3] ? parseInt(aMatch[3], 10) : 0;
-      const bMajor = parseInt(bMatch[1], 10);
-      const bMinor = parseInt(bMatch[2], 10);
-      const bPatch = bMatch[3] ? parseInt(bMatch[3], 10) : 0;
-      if (aMajor !== bMajor) return bMajor - aMajor;
-      if (aMinor !== bMinor) return bMinor - aMinor;
-      return bPatch - aPatch;
-    };
-
-    // Sorting function for beta releases.
-    const sortBeta = (a, b) => {
-      const aMatch = a.tag_name.match(betaRegex);
-      const bMatch = b.tag_name.match(betaRegex);
-      if (!aMatch || !bMatch) return 0;
-      const aMajor = parseInt(aMatch[1], 10);
-      const aMinor = parseInt(aMatch[2], 10);
-      const aPatch = aMatch[3] ? parseInt(aMatch[3], 10) : 0;
-      // Optional beta number; if not provided, assume 0.
-      const aBeta = aMatch[4] ? parseInt(aMatch[4], 10) : 0;
-      const bMajor = parseInt(bMatch[1], 10);
-      const bMinor = parseInt(bMatch[2], 10);
-      const bPatch = bMatch[3] ? parseInt(bMatch[3], 10) : 0;
-      const bBeta = bMatch[4] ? parseInt(bMatch[4], 10) : 0;
-      if (aMajor !== bMajor) return bMajor - aMajor;
-      if (aMinor !== bMinor) return bMinor - aMinor;
-      if (aPatch !== bPatch) return bPatch - aPatch;
-      return bBeta - aBeta;
-    };
-
-    // Sort both arrays in descending order.
-    stableReleases.sort(sortStable);
-    betaReleases.sort(sortBeta);
-
-    // Get the highest tag from each group, if available.
-    const latestStableTag = stableReleases.length ? stableReleases[0].tag_name : null;
-    const latestBetaTag = betaReleases.length ? betaReleases[0].tag_name : null;
-
-    // Helper function to fetch and parse Chart.yaml from a given tag.
-    const fetchChartVersion = async (tag) => {
-      if (!tag) return null;
-      try {
-        const contentResponse = await github.repos.getContent({
-          owner,
-          repo,
-          path,
-          ref: tag,
-        });
-        const contentBase64 = contentResponse.data.content;
-        const contentDecoded = Buffer.from(contentBase64, 'base64').toString('utf8');
-        const chartYaml = yaml.load(contentDecoded);
-        return chartYaml.version || null;
-      } catch (error) {
-        console.error(`Failed to fetch Chart.yaml for tag ${tag}:`, error.message);
-        return null;
-      }
-    };
-
-    const [latestStableReleaseVersion, latestBetaReleaseVersion] = await Promise.all([
-      fetchChartVersion(latestStableTag),
-      fetchChartVersion(latestBetaTag)
-    ]);
-
-    return {
-      latestStableRelease: latestStableReleaseVersion,
-      latestBetaRelease: latestBetaReleaseVersion
-    };
-
-  } catch (error) {
-    console.error('Failed to fetch chart version:', error.message);
-    return {
-      latestStableRelease: null,
-      latestBetaRelease: null
-    };
-  }
-};