@redpanda-data/docs-extensions-and-macros 4.10.4 → 4.10.6

package/package.json

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

package/tools/bundle-openapi.js

@@ -28,21 +28,15 @@ function normalizeTag(tag) {
     throw new Error('Invalid version format: tag cannot be empty');
   }
   
-  // Handle dev branch
-  if (tag === 'dev') {
-    return 'dev';
-  }
-  
   // Remove 'v' prefix if present
   const normalized = tag.startsWith('v') ? tag.slice(1) : tag;
-  
   // Validate semantic version format
   const semverPattern = /^\d+\.\d+\.\d+(-[\w\.-]+)?(\+[\w\.-]+)?$/;
-  if (!semverPattern.test(normalized) && normalized !== 'dev') {
-    throw new Error(`Invalid version format: ${tag}. Expected format like v25.1.1 or 25.1.1`);
+  if (semverPattern.test(normalized)) {
+    return normalized;
   }
-  
-  return normalized;
+  // If not a valid semver, treat as branch name and return as-is
+  return tag;
 }
 
 /**
@@ -59,22 +53,20 @@ function getMajorMinor(version) {
     throw new Error('Version must be a non-empty string');
   }
   
-  if (version === 'dev') {
-    return 'dev';
+  // Only process if valid semver, else return as-is (branch name)
+  const semverPattern = /^\d+\.\d+\.\d+(-[\w\.-]+)?(\+[\w\.-]+)?$/;
+  if (!semverPattern.test(version)) {
+    return version;
   }
-  
   const parts = version.split('.');
   if (parts.length < 2) {
     throw new Error(`Invalid version format: ${version}. Expected X.Y.Z format`);
   }
-  
   const major = parseInt(parts[0], 10);
   const minor = parseInt(parts[1], 10);
-  
   if (isNaN(major) || isNaN(minor)) {
     throw new Error(`Major and minor versions must be numbers: ${version}`);
   }
-  
   return `${major}.${minor}`;
 }
 

package/tools/property-extractor/generate-handlebars-docs.js

@@ -1,3 +1,4 @@
+const AUTOGEN_NOTICE = '// This content is autogenerated. Do not edit manually. To override descriptions, use the doc-tools CLI with the --overrides option: https://redpandadata.atlassian.net/wiki/spaces/DOC/pages/1396244485/Review+Redpanda+configuration+properties\n';
 'use strict';
 
 const fs = require('fs');
@@ -144,7 +145,7 @@ function generatePropertyPartials(properties, partialsDir) {
     const selectedTemplate = type === 'topic' ? topicTemplate : propertyTemplate;
     const content = props.map(p => selectedTemplate(p)).join('\n');
     const filename = `${type}-properties.adoc`;
-    fs.writeFileSync(path.join(propertiesPartialsDir, filename), content, 'utf8');
+  fs.writeFileSync(path.join(propertiesPartialsDir, filename), AUTOGEN_NOTICE + content, 'utf8');
     console.log(`✅ Generated ${filename} (${props.length} properties)`);
     totalCount += props.length;
   });
@@ -183,7 +184,7 @@ function generateDeprecatedDocs(properties, outputDir) {
     : path.join(outputDir, 'partials', 'deprecated', 'deprecated-properties.adoc');
 
   fs.mkdirSync(path.dirname(outputPath), { recursive: true });
-  fs.writeFileSync(outputPath, output, 'utf8');
+  fs.writeFileSync(outputPath, AUTOGEN_NOTICE + output, 'utf8');
   console.log(`✅ Generated ${outputPath}`);
   return deprecatedProperties.length;
 }
@@ -211,7 +212,7 @@ function generateTopicPropertyMappings(properties, partialsDir) {
   const hbs = handlebars.compile(hbsSource);
   const rendered = hbs({ topicProperties });
   const mappingsOut = path.join(partialsDir, 'topic-property-mappings.adoc');
-  fs.writeFileSync(mappingsOut, rendered, 'utf8');
+  fs.writeFileSync(mappingsOut, AUTOGEN_NOTICE + rendered, 'utf8');
   console.log(`✅ Generated ${mappingsOut}`);
   return topicProperties.length;
 }

package/tools/redpanda-connect/templates/examples-partials.hbs

@@ -1,5 +1,5 @@
 {{#with examples}}
-// This content is autogenerated. Do not edit manually.
+// This content is autogenerated. Do not edit manually. To override descriptions, use the doc-tools CLI with the --overrides option: https://redpandadata.atlassian.net/wiki/spaces/DOC/pages/1247543314/Generate+reference+docs+for+Redpanda+Connect
 
 == Examples