@redpanda-data/docs-extensions-and-macros 3.2.7 → 3.2.9

package/extensions/unpublish-pages.js

@@ -0,0 +1,9 @@
+module.exports.register = function () {
+  this.on('documentsConverted', ({ contentCatalog }) => {
+    contentCatalog.getPages((page) => page.out).forEach((page) => {
+      if (page.asciidoc?.attributes['page-unpublish'] != null || page.asciidoc?.attributes['page-layout'] === 'api-partial') {
+        delete page.out
+      }
+    })
+  })
+}

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

@@ -18,11 +18,11 @@ const github = new OctokitWithRetries(githubOptions);
 
 module.exports = async () => {
   try {
-    // Fetch the latest 10 releases
     const releases = await github.rest.repos.listReleases({
       owner,
       repo,
-      per_page: 10,
+      page: 1,
+      per_page: 50
     });
 
     // Filter valid semver tags and sort them

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

@@ -0,0 +1,33 @@
+const { Octokit } = require("@octokit/rest");
+const { retry } = require("@octokit/plugin-retry");
+const yaml = require('js-yaml');
+const OctokitWithRetries = Octokit.plugin(retry);
+
+const githubOptions = {
+  userAgent: 'Redpanda Docs',
+  baseUrl: 'https://api.github.com',
+  auth: process.env.REDPANDA_GITHUB_TOKEN
+};
+
+const github = new OctokitWithRetries(githubOptions);
+const owner = 'redpanda-data';
+const repo = 'helm-charts';
+const path = 'charts/redpanda/Chart.yaml';
+
+module.exports = async () => {
+  try {
+    const response = await github.repos.getContent({
+      owner: owner,
+      repo: repo,
+      path: path,
+    });
+
+    const contentBase64 = response.data.content;
+    const contentDecoded = Buffer.from(contentBase64, 'base64').toString('utf8');
+    const chartYaml = yaml.load(contentDecoded);
+    return chartYaml.version;
+  } catch (error) {
+    console.error('Failed to fetch chart version:', error.message);
+    return null
+  }
+};

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

@@ -1,7 +1,8 @@
-// Fetch the latest release version from GitHub
 const { Octokit } = require("@octokit/rest");
 const { retry } = require("@octokit/plugin-retry");
+const semver = require("semver");
 const OctokitWithRetries = Octokit.plugin(retry);
+
 const owner = 'redpanda-data';
 const repo = 'redpanda';
 
@@ -18,22 +19,40 @@ const github = new OctokitWithRetries(githubOptions);
 
 module.exports = async () => {
   try {
-    // Fetch the latest release
-    const release = await github.rest.repos.getLatestRelease({ owner, repo });
-    const tag = release.data.tag_name;
-    latestRedpandaReleaseVersion = tag.replace('v', '');
+    // Fetch all the releases from the repository
+    const releases = await github.rest.repos.listReleases({
+      owner,
+      repo,
+      page: 1,
+      per_page: 50
+    });
+
+    // Filter valid semver tags and sort them to find the highest version
+    const sortedReleases = releases.data
+      .map(release => release.tag_name.replace(/^v/, ''))
+      .filter(tag => semver.valid(tag))
+      // Sort in descending order to get the highest version first
+      .sort(semver.rcompare);
+    console.log(sortedReleases)
 
-    // Get reference of the tag
-    const tagRef = await github.rest.git.getRef({ owner, repo, ref: `tags/${tag}` });
-    const releaseSha = tagRef.data.object.sha;
+    if (sortedReleases.length > 0) {
+      const latestRedpandaReleaseVersion = sortedReleases[0];
 
-    // Get the tag object to extract the commit hash
-    const tagData = await github.rest.git.getTag({ owner, repo, tag_sha: releaseSha });
-    latestRedpandaReleaseCommitHash = tagData.data.object.sha.substring(0, 7);
+      // Get the commit hash for the highest version tag
+      const commitData = await github.rest.git.getRef({
+        owner,
+        repo,
+        ref: `tags/v${latestRedpandaReleaseVersion}`
+      });
+      const latestRedpandaReleaseCommitHash = commitData.data.object.sha;
 
-    return [latestRedpandaReleaseVersion, latestRedpandaReleaseCommitHash];
+      return [latestRedpandaReleaseVersion, latestRedpandaReleaseCommitHash.substring(0, 7)];
+    } else {
+      console.log("No valid semver releases found for Redpanda.");
+      return [null, null];
+    }
   } catch (error) {
-    console.error(error);
+    console.error('Failed to fetch Redpanda release information:', error);
     return [null, null];
   }
-};
+};

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

@@ -1,70 +1,70 @@
-/* Example:
-antora:
-  extensions:
-  - require: ./extensions/setLatestVersion.js
-*/
-
 const GetLatestRedpandaVersion = require('./get-latest-redpanda-version');
 const GetLatestConsoleVersion = require('./get-latest-console-version');
 const GetLatestOperatorVersion = require('./get-latest-operator-version');
-const chalk = require('chalk')
-
+const GetLatestHelmChartVersion = require('./get-latest-redpanda-helm-version');
+const chalk = require('chalk');
 
 module.exports.register = function ({ config }) {
-  const logger = this.getLogger('set-latest-version-extension')
+  const logger = this.getLogger('set-latest-version-extension');
   if (!process.env.REDPANDA_GITHUB_TOKEN) {
     logger.warn('REDPANDA_GITHUB_TOKEN environment variable not set. Attempting unauthenticated request.');
   }
-  this
-    .on('contentClassified', async ({ contentCatalog }) => {
-      try {
-        const LatestRedpandaVersion = await GetLatestRedpandaVersion();
-        const LatestConsoleVersion = await GetLatestConsoleVersion();
-        const LatestOperatorVersion = await GetLatestOperatorVersion();
-        if (LatestRedpandaVersion.length !== 2 || !LatestRedpandaVersion[0]) {
-          logger.warn('Failed to get the latest Redpanda version - using defaults');
-        }
-        if (!LatestConsoleVersion) {
-          logger.warn(`Failed to get latest Console version from GitHub - using default`)
-        }
-        if (!LatestOperatorVersion) {
-          logger.warn(`Failed to get latest Operator version from GitHub - using default`)
-        }
-        const components = await contentCatalog.getComponents();
-        for (let i = 0; i < components.length; i++) {
-          let component = components[i];
 
-          component.versions.forEach(({name, version, asciidoc}) => {
-            if (LatestConsoleVersion) {
-              asciidoc.attributes['latest-console-version'] = `${LatestConsoleVersion}`;
-              logger.info(`Set Redpanda Console version to')} ${LatestConsoleVersion} in ${name} ${version}`);
-            }
-          })
+  this.on('contentClassified', async ({ contentCatalog }) => {
+    try {
+      const results = await Promise.allSettled([
+        GetLatestRedpandaVersion(),
+        GetLatestConsoleVersion(),
+        GetLatestOperatorVersion(),
+        GetLatestHelmChartVersion()
+      ]);
 
-          if (!component.latest.asciidoc) {
-            component.latest.asciidoc = {};
-          }
+      // Extracting results with fallbacks if promises were rejected
+      const LatestRedpandaVersion = results[0].status === 'fulfilled' ? results[0].value : null;
+      const LatestConsoleVersion = results[1].status === 'fulfilled' ? results[1].value : null;
+      const LatestOperatorVersion = results[2].status === 'fulfilled' ? results[2].value : null;
+      const LatestHelmChartVersion = results[3].status === 'fulfilled' ? results[3].value : null;
 
-          if (!component.latest.asciidoc.attributes) {
-            component.latest.asciidoc.attributes = {};
+      const components = await contentCatalog.getComponents();
+      components.forEach(component => {
+        component.versions.forEach(({ name, version, asciidoc }) => {
+          if (LatestConsoleVersion) {
+            asciidoc.attributes['latest-console-version'] = LatestConsoleVersion;
+            logger.info(`Set Redpanda Console version to ${LatestConsoleVersion} in ${name} ${version}`);
           }
+        });
 
-          if (LatestRedpandaVersion.length !== 2 || !LatestRedpandaVersion[0]) continue;
+        if (!component.latest.asciidoc) {
+          component.latest.asciidoc = { attributes: {} };
+        }
 
-          component.latest.asciidoc.attributes['full-version'] = `${LatestRedpandaVersion[0]}`;
-          component.latest.asciidoc.attributes['latest-release-commit'] = `${LatestRedpandaVersion[1]}`;
-          logger.info(`Set the latest Redpanda version to ${LatestRedpandaVersion[0]} ${LatestRedpandaVersion[1]}`)
+        // Handle each version setting with appropriate logging
+        if (LatestRedpandaVersion) {
+          component.latest.asciidoc.attributes['full-version'] = LatestRedpandaVersion[0];
+          component.latest.asciidoc.attributes['latest-release-commit'] = LatestRedpandaVersion[1];
+          logger.info(`Set the latest Redpanda version to ${LatestRedpandaVersion[0]} ${LatestRedpandaVersion[1]}`);
+        } else {
+          logger.warn("Failed to get the latest Redpanda version - using defaults");
+        }
 
-          if (!LatestOperatorVersion) continue;
+        if (LatestOperatorVersion) {
+          component.latest.asciidoc.attributes['latest-operator-version'] = LatestOperatorVersion;
+          logger.info(`Set the latest Redpanda Operator version to ${LatestOperatorVersion}`);
+        } else {
+          logger.warn("Failed to get the latest Operator version from GitHub - using default");
+        }
 
-          component.latest.asciidoc.attributes['latest-operator-version'] = `${LatestOperatorVersion}`;
-          logger.info(`Set the latest Redpanda Operator version to ${LatestOperatorVersion}`)
+        if (LatestHelmChartVersion) {
+          component.latest.asciidoc.attributes['latest-redpanda-helm-chart-version'] = LatestHelmChartVersion;
+          logger.info(`Set the latest Redpanda Helm chart version to ${LatestHelmChartVersion}`);
+        } else {
+          logger.warn("Failed to get the latest Helm Chart version - using default");
         }
-        console.log(`${chalk.green('Set Redpanda Console version to')} ${chalk.bold(LatestConsoleVersion)}`);
-        console.log(`${chalk.green('Set the latest Redpanda version to')} ${chalk.bold(LatestRedpandaVersion[0])} ${chalk.bold(LatestRedpandaVersion[1])}`)
-        console.log(`${chalk.green('Set the latest Redpanda Operator version to')} ${chalk.bold(LatestOperatorVersion)}`)
-      } catch(error) {
-        logger.warn(error)
-      }
-    })
-}
+      });
+
+      console.log(`${chalk.green('Updated Redpanda documentation versions successfully.')}`);
+    } catch (error) {
+      logger.error(`Error updating versions: ${error}`);
+    }
+  });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redpanda-data/docs-extensions-and-macros",
-  "version": "3.2.7",
+  "version": "3.2.9",
   "description": "Antora extensions and macros developed for Redpanda documentation.",
   "keywords": [
     "antora",
@@ -34,6 +34,7 @@
     "./extensions/version-fetcher/set-latest-version": "./extensions/version-fetcher/set-latest-version.js",
     "./extensions/validate-attributes": "./extensions/validate-attributes.js",
     "./extensions/find-related-docs": "./extensions/find-related-docs.js",
+    "./extensions/unpublish-pages": "./extensions/unpublish-pages.js",
     "./extensions/find-related-labs": "./extensions/find-related-labs.js",
     "./extensions/modify-redirects": "./extensions/produce-redirects.js",
     "./extensions/algolia-indexer/index": "./extensions/algolia-indexer/index.js",