Fix Redpanda Connect cloud-only connector automation #164
Conversation
✅ Deploy Preview for docs-extensions-and-macros ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe PR bumps the package version to 4.13.4 and modifies description sourcing in two connector documentation tools. Both Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
⛔ Files ignored due to path filters (1)
📒 Files selected for processing (3)
🧰 Additional context used🧬 Code graph analysis (1)tools/redpanda-connect/pr-summary-formatter.js (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
🔇 Additional comments (8)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
tools/redpanda-connect/rpcn-connector-docs-handler.js (1)
230-230: Inconsistent truncation:summarybypassescapToTwoSentences.At line 230,
capToTwoSentencesis applied only tocomp.description, not tocomp.summary. This differs from the pattern used elsewhere (lines 192-194, 205-207, 272-273) where the function is applied to the resolved value (either summary or description).If a component has a lengthy
summary, it will appear in the whats-new.adoc table without truncation, potentially breaking table formatting or creating inconsistent description lengths.🔎 Proposed fix to ensure consistent truncation
- let desc = comp.summary || (comp.description ? capToTwoSentences(comp.description) : '// TODO: Add description') + const descText = comp.summary || comp.description + let desc = descText ? capToTwoSentences(descText) : '// TODO: Add description'This matches the pattern used for deprecated components (lines 272-273) and ensures both
summaryanddescriptionare truncated consistently.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (3)
package.jsontools/redpanda-connect/pr-summary-formatter.jstools/redpanda-connect/rpcn-connector-docs-handler.js
🧰 Additional context used
🧬 Code graph analysis (1)
tools/redpanda-connect/pr-summary-formatter.js (1)
tools/redpanda-connect/rpcn-connector-docs-handler.js (6)
desc(192-192)desc(205-205)desc(230-230)desc(273-273)desc(389-389)desc(437-437)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - docs-extensions-and-macros
- GitHub Check: Header rules - docs-extensions-and-macros
- GitHub Check: Pages changed - docs-extensions-and-macros
🔇 Additional comments (8)
package.json (1)
3-3: LGTM: Version bump follows semantic versioning.The patch version increment from 4.13.3 to 4.13.4 is appropriate for this release.
tools/redpanda-connect/pr-summary-formatter.js (3)
400-404: LGTM: Consistent fallback and truncation logic.The code correctly prefers
summaryoverdescriptionand applies truncation consistently to the resolved value.
414-418: LGTM: Consistent with cloud-supported section.The description handling for self-hosted connectors matches the pattern used for cloud-supported connectors.
426-430: LGTM: Consistent fallback across all code paths.The description handling maintains consistency whether cloud binary analysis is available or not.
tools/redpanda-connect/rpcn-connector-docs-handler.js (4)
192-194: LGTM: Consistent description handling for Bloblang functions.The code correctly prefers
summaryoverdescriptionand appliescapToTwoSentencesto the resolved value, ensuring bounded text length in the changelog.
205-207: LGTM: Consistent with Bloblang functions handling.The description logic for Bloblang methods matches the pattern used for Bloblang functions.
272-273: LGTM: Consistent truncation for deprecated components.The description handling correctly applies
capToTwoSentencesto whichever value is present (summary or description), maintaining consistency with Bloblang components.
919-921: LGTM: Critical reload ensures subsequent processing uses augmented data.Reloading
newIndexafter augmentation is essential to ensure that diff generation (lines 928-1057) and PR summary formatting operate on data that includes the newly addedcloudSupported,requiresCgo, andcloudOnlyfields. The comment clearly documents this intention.
This pull request updates the logic for generating summaries and descriptions of components in the Redpanda documentation tooling. The main improvement is that, wherever a component has a
summaryfield, it will now be preferred over thedescriptionfield for display in summaries and changelogs. This ensures that more concise and relevant information is shown to users. Additionally, the documentation data is now reloaded after augmentation to ensure that the most up-to-date information is used in subsequent processing.Component summary handling improvements:
tools/redpanda-connect/pr-summary-formatter.jsandtools/redpanda-connect/rpcn-connector-docs-handler.jsto prefer thesummaryfield overdescriptionwhen generating summaries for new, self-hosted, or deprecated components. This makes changelogs and documentation more concise and user-friendly. [1] [2] [3] [4] [5] [6]Documentation data consistency:
Other changes:
package.jsonfrom4.13.3to4.13.4.