@redpanda-data/docs-extensions-and-macros 3.1.3 → 3.1.5

package/README.adoc

@@ -79,9 +79,11 @@ antora:
 
 === Version fetcher
 
-This extension fetches the latest release tag and latest release commit hash from http://github.com/redpanda-data/redpanda. These values are then assigned to the `full-version` and `latest-release-commit` attributes of the latest version of the Redpanda documentation, respectively.
+This extension fetches the latest release versions from GitHub.
 
-It also fetches the latest version of Redpanda Console and assigns it to the `latest-console-version` attribute in the playbook so that all components have access to it.
+The latest Console version is made available to all versions of the Redpanda docs (`ROOT` component.)
+
+The latest Redpanda version and the latest Redpanda Operator version is made available to the latest version of the `ROOT` component.
 
 ==== Environment variables
 

package/extensions/algolia-indexer/generate-index.js

@@ -28,6 +28,8 @@ function generateIndex (playbook, contentCatalog, { indexLatestOnly = false, exc
 
   console.log(chalk.cyan('Indexing...'))
 
+  const unixTimestamp = Math.floor(Date.now() / 1000)
+
   // Select indexable pages
   const pages = contentCatalog.getPages((page) => {
     if (!page.out || page.asciidoc?.attributes?.noindex != null) return
@@ -45,7 +47,6 @@ function generateIndex (playbook, contentCatalog, { indexLatestOnly = false, exc
   }
   const urlPath = extractUrlPath(siteUrl)
 
-  const documents = {}
   var algoliaCount = 0
 
   for (var i = 0; i < pages.length; i++) {
@@ -181,13 +182,13 @@ function generateIndex (playbook, contentCatalog, { indexLatestOnly = false, exc
       title: documentTitle,
       product: component.title,
       version: version,
-      //image: image? image: '',
       text: text,
       breadcrumbs: breadcrumbs,
       intro: intro,
       objectID: urlPath + page.pub.url,
       titles: titles,
       keywords: keywords,
+      unixTimestamp: unixTimestamp,
       type: 'Doc',
       _tags: [tag, 'docs']
     }

package/extensions/version-fetcher/{getLatestConsoleVersion.js → get-latest-console-version.js}

@@ -19,15 +19,12 @@ const github = new OctokitWithRetries(githubOptions);
 var latestConsoleReleaseVersion;
 
 module.exports = async () => {
-  await github.rest.repos.getLatestRelease({
-    owner,
-    repo,
-  }).then((release => {
-    const tag = release.data.tag_name;
-    latestConsoleReleaseVersion = tag.replace('v','');
-  })).catch((error => {
-    console.error(error)
-    return null
-  }))
-  return latestConsoleReleaseVersion;
+  try {
+    const release = await github.rest.repos.getLatestRelease({ owner, repo });
+    latestConsoleReleaseVersion = release.data.tag_name.replace('v','');
+    return latestConsoleReleaseVersion;
+  } catch (error) {
+    console.error(error);
+    return null;
+  }
 };

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

@@ -0,0 +1,28 @@
+// Fetch the latest release version from GitHub
+const { Octokit } = require("@octokit/rest");
+const { retry } = require("@octokit/plugin-retry");
+const OctokitWithRetries = Octokit.plugin(retry);
+const owner = 'redpanda-data';
+const repo = 'redpanda-operator';
+
+let githubOptions = {
+  userAgent: 'Redpanda Docs',
+  baseUrl: 'https://api.github.com',
+};
+
+if (process.env.REDPANDA_GITHUB_TOKEN) {
+  githubOptions.auth = process.env.REDPANDA_GITHUB_TOKEN;
+}
+
+const github = new OctokitWithRetries(githubOptions);
+
+module.exports = async () => {
+  try {
+    const release = await github.rest.repos.getLatestRelease({ owner, repo });
+    latestOperatorReleaseVersion = release.data.tag_name;
+    return latestOperatorReleaseVersion;
+  } catch (error) {
+    console.error(error);
+    return null;
+  }
+};

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

@@ -0,0 +1,39 @@
+// Fetch the latest release version from GitHub
+const { Octokit } = require("@octokit/rest");
+const { retry } = require("@octokit/plugin-retry");
+const OctokitWithRetries = Octokit.plugin(retry);
+const owner = 'redpanda-data';
+const repo = 'redpanda';
+
+let githubOptions = {
+  userAgent: 'Redpanda Docs',
+  baseUrl: 'https://api.github.com',
+};
+
+if (process.env.REDPANDA_GITHUB_TOKEN) {
+  githubOptions.auth = process.env.REDPANDA_GITHUB_TOKEN;
+}
+
+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', '');
+
+    // Get reference of the tag
+    const tagRef = await github.rest.git.getRef({ owner, repo, ref: `tags/${tag}` });
+    const releaseSha = tagRef.data.object.sha;
+
+    // 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);
+
+    return [latestRedpandaReleaseVersion, latestRedpandaReleaseCommitHash];
+  } catch (error) {
+    console.error(error);
+    return [null, null];
+  }
+};

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

@@ -4,8 +4,9 @@ antora:
   - require: ./extensions/setLatestVersion.js
 */
 
-const GetLatestRedpandaVersion = require('./getLatestRedpandaVersion');
-const GetLatestConsoleVersion = require('./getLatestConsoleVersion');
+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')
 
 
@@ -19,12 +20,16 @@ module.exports.register = function ({ config }) {
       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];
@@ -50,6 +55,11 @@ module.exports.register = function ({ config }) {
           component.latest.asciidoc.attributes['full-version'] = `${LatestRedpandaVersion[0]}`;
           component.latest.asciidoc.attributes['latest-release-commit'] = `${LatestRedpandaVersion[1]}`;
           console.log(`${chalk.green('Set the latest Redpanda version to')} ${chalk.bold(LatestRedpandaVersion[0])} ${chalk.bold(LatestRedpandaVersion[1])}`)
+
+          if (!LatestOperatorVersion) continue;
+
+          component.latest.asciidoc.attributes['latest-operator-version'] = `${LatestOperatorVersion}`;
+          console.log(`${chalk.green('Set the latest Redpanda Operator version to')} ${chalk.bold(LatestOperatorVersion)}`)
         }
       } catch(error) {
         logger.warn(error)

package/package.json

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

package/extensions/version-fetcher/getLatestRedpandaVersion.js

@@ -1,46 +0,0 @@
-// Fetch the latest release version from GitHub
-const { Octokit } = require("@octokit/rest");
-const { retry } = require("@octokit/plugin-retry");
-const OctokitWithRetries = Octokit.plugin(retry);
-const owner = 'redpanda-data';
-const repo = 'redpanda';
-
-let githubOptions = {
-  userAgent: 'Redpanda Docs',
-  baseUrl: 'https://api.github.com',
-};
-
-if (process.env.REDPANDA_GITHUB_TOKEN) {
-  githubOptions.auth = process.env.REDPANDA_GITHUB_TOKEN;
-}
-
-const github = new OctokitWithRetries(githubOptions);
-
-var latestRedpandaReleaseVersion;
-var latestRedpandaReleaseCommitHash;
-
-module.exports = async () => {
-  await github.rest.repos.getLatestRelease({
-    owner,
-    repo,
-  }).then(async function(release) {
-    const tag = release.data.tag_name;
-    latestRedpandaReleaseVersion = tag.replace('v','');
-    await github.rest.git.getRef({
-      owner,
-      repo,
-      ref: `/tags/${tag}`,
-    }).then(async function(tagRef) {
-      const releaseSha = tagRef.data.object.sha;
-      await github.rest.git.getTag({
-        owner,
-        repo,
-        tag_sha: releaseSha,
-      }).then((tag => latestRedpandaReleaseCommitHash = tag.data.object.sha.substring(0, 7)))
-    })
-  }).catch((error => {
-    console.error(error)
-    return null
-  }))
-  return [latestRedpandaReleaseVersion, latestRedpandaReleaseCommitHash];
-};