diff --git a/package-lock.json b/package-lock.json index aa2cd30..209b5d7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@redpanda-data/docs-extensions-and-macros", - "version": "4.13.3", + "version": "4.13.4", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@redpanda-data/docs-extensions-and-macros", - "version": "4.13.3", + "version": "4.13.4", "license": "ISC", "dependencies": { "@asciidoctor/tabs": "^1.0.0-beta.6", diff --git a/package.json b/package.json index d3daa87..008f8ef 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@redpanda-data/docs-extensions-and-macros", - "version": "4.13.3", + "version": "4.13.4", "description": "Antora extensions and macros developed for Redpanda documentation.", "keywords": [ "antora", diff --git a/tools/redpanda-connect/pr-summary-formatter.js b/tools/redpanda-connect/pr-summary-formatter.js index 8361b61..f7bbe67 100644 --- a/tools/redpanda-connect/pr-summary-formatter.js +++ b/tools/redpanda-connect/pr-summary-formatter.js @@ -397,8 +397,9 @@ function generatePRSummary(diffData, binaryAnalysis = null, draftedConnectors = lines.push(''); cloudSupportedNew.forEach(c => { lines.push(`- **${c.name}** (${c.type}, ${c.status})`); - if (c.description) { - const shortDesc = truncateToSentence(c.description, 2); + const desc = c.summary || c.description; + if (desc) { + const shortDesc = truncateToSentence(desc, 2); lines.push(` - ${shortDesc}`); } }); @@ -410,8 +411,9 @@ function generatePRSummary(diffData, binaryAnalysis = null, draftedConnectors = lines.push(''); selfHostedOnlyNew.forEach(c => { lines.push(`- **${c.name}** (${c.type}, ${c.status})`); - if (c.description) { - const shortDesc = truncateToSentence(c.description, 2); + const desc = c.summary || c.description; + if (desc) { + const shortDesc = truncateToSentence(desc, 2); lines.push(` - ${shortDesc}`); } }); @@ -421,8 +423,9 @@ function generatePRSummary(diffData, binaryAnalysis = null, draftedConnectors = // No cloud support info, just list all diffData.details.newComponents.forEach(c => { lines.push(`- **${c.name}** (${c.type}, ${c.status})`); - if (c.description) { - const shortDesc = truncateToSentence(c.description, 2); + const desc = c.summary || c.description; + if (desc) { + const shortDesc = truncateToSentence(desc, 2); lines.push(` - ${shortDesc}`); } }); diff --git a/tools/redpanda-connect/rpcn-connector-docs-handler.js b/tools/redpanda-connect/rpcn-connector-docs-handler.js index 77b5429..ff83d1a 100644 --- a/tools/redpanda-connect/rpcn-connector-docs-handler.js +++ b/tools/redpanda-connect/rpcn-connector-docs-handler.js @@ -189,8 +189,9 @@ function updateWhatsNew ({ dataDir, oldVersion, newVersion, binaryAnalysis }) { for (const comp of comps) { section += `** xref:guides:bloblang/functions.adoc#${comp.name}[\`${comp.name}\`]` if (comp.status && comp.status !== 'stable') section += ` (${comp.status})` - if (comp.description) { - section += `: ${capToTwoSentences(comp.description)}` + const desc = comp.summary || comp.description + if (desc) { + section += `: ${capToTwoSentences(desc)}` } else { section += `\n+\n// TODO: Add description for ${comp.name} function` } @@ -201,8 +202,9 @@ function updateWhatsNew ({ dataDir, oldVersion, newVersion, binaryAnalysis }) { for (const comp of comps) { section += `** xref:guides:bloblang/methods.adoc#${comp.name}[\`${comp.name}\`]` if (comp.status && comp.status !== 'stable') section += ` (${comp.status})` - if (comp.description) { - section += `: ${capToTwoSentences(comp.description)}` + const desc = comp.summary || comp.description + if (desc) { + section += `: ${capToTwoSentences(desc)}` } else { section += `\n+\n// TODO: Add description for ${comp.name} method` } @@ -267,7 +269,8 @@ function updateWhatsNew ({ dataDir, oldVersion, newVersion, binaryAnalysis }) { for (const comp of diff.details.deprecatedComponents) { const typeLabel = comp.type.charAt(0).toUpperCase() + comp.type.slice(1) - const desc = comp.description ? capToTwoSentences(comp.description) : '-' + const descText = comp.summary || comp.description + const desc = descText ? capToTwoSentences(descText) : '-' if (comp.type === 'bloblang-functions') { section += `|xref:guides:bloblang/functions.adoc#${comp.name}[${comp.name}]\n` @@ -913,6 +916,9 @@ async function handleRpcnConnectorDocs (options) { fs.unlinkSync(oldestPath) console.log(`🧹 Deleted old version from docs-data: ${oldestFile}`) } + + // Reload newIndex after augmentation so diff generation uses augmented data + newIndex = JSON.parse(fs.readFileSync(dataFile, 'utf8')) } catch (err) { console.error(`Warning: Failed to augment data file: ${err.message}`) }