Fix/array of objects and cloud docs check

[JakeSCahill]

This pull request centralizes and standardizes the use of the GitHub Octokit client across the codebase by introducing a shared singleton instance, and improves connector documentation checks for Redpanda Cloud. The main themes are infrastructure simplification for GitHub API access and enhancements to connector documentation validation logic.

Centralized GitHub Octokit client:

• Added a new octokit-client.js module in cli-utils to provide a shared, singleton Octokit client with consistent authentication and retry logic, reducing redundant initialization and improving rate limit tracking.
• Refactored all scripts and tools (generate-rp-connect-info.js, fetch-from-github.js, get-console-version.js, get-redpanda-version.js, connector-binary-analyzer.js, generate-cloud-regions.js) to use the new shared Octokit client instead of creating their own instances. [1] [2] [3] [4] [5] [6] [7]

Connector documentation validation improvements:

• Enhanced the Redpanda Connect documentation handler to:
  • Track cloudOnly and requiresCgo flags for connectors.
  • Build a set of cloud-supported connectors using binary analysis or fallback logic.
  • Check for missing connector documentation in both the local repo and the cloud-docs repository using the shared Octokit client, with robust error handling and fallback to raw HTTP requests. [1] [2]

Connector YAML rendering improvements:

• Updated YAML rendering logic to properly handle array-of-object fields (e.g., client_certs[]) so they are rendered as empty arrays instead of expanded object structures in both buildConfigYaml.js and renderObjectField.js. [1] [2]

Dependency and version updates:

• Bumped the package version to 4.13.5 and added dotenv as a dependency in package.json. [1] [2]

[netlify]

✅ Deploy Preview for docs-extensions-and-macros ready!

Name	Link
🔨 Latest commit	4ebb6dd
🔍 Latest deploy log	https://app.netlify.com/projects/docs-extensions-and-macros/deploys/696f9e9d4c5def00084303b1
😎 Deploy Preview	https://deploy-preview-166--docs-extensions-and-macros.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request includes a version bump to 4.13.5 and introduces enhancements to handle array-of-object fields in YAML configuration generation. Two helper functions are updated to render arrays of objects as YAML leaf arrays (e.g., client_certs: []) instead of expanding them recursively. Additionally, the connector docs handler gains cloud-docs awareness to track cloud-supported connectors and validate their documentation status via GitHub API integration.

Sequence Diagram

sequenceDiagram
    participant Handler as rpcn-connector-docs-handler
    participant CloudSet as cloudSupportedSet<br/>(Tracking)
    participant GitHub as GitHub API
    participant CloudDocs as Cloud-docs<br/>Repository
    participant Logger as Log Output

    Handler->>CloudSet: Track connectors in OSS and Cloud
    Note over CloudSet: inCloud, cloudOnly sets
    
    Handler->>Handler: Check cloud-only connectors<br/>in cloud-only directory
    Handler->>Logger: Log results for cloud-only
    
    Handler->>GitHub: Query cloud-docs repo<br/>for missing cloud-supported<br/>connectors
    GitHub->>CloudDocs: Retrieve cloud-supported<br/>connector docs
    CloudDocs-->>GitHub: Return docs status
    GitHub-->>Handler: Response with missing entries
    
    Handler->>Logger: Emit cloud-docs<br/>check results
    Handler->>Logger: Handle errors gracefully

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• Fix object Object bug in RPCN automation #153: Implements array-of-object field rendering as YAML leaf arrays instead of expanding nested structures, matching the pattern introduced in buildConfigYaml.js and renderObjectField.js
• Fix Redpanda Connect cloud-only connector automation #163: Extends cloud-docs and cloud-only connector handling in the rpcn-connector-docs-handler module, directly building on the cloud-awareness integration introduced here

Suggested reviewers

• paulohtb6
• micheleRP

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Fix/array of objects and cloud docs check' directly references the two main changes in the PR: fixing array-of-objects rendering and adding cloud docs validation checks.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check	✅ Passed	The pull request description comprehensively addresses all major changes in the changeset, including centralized Octokit client, connector documentation validation, YAML rendering improvements, and version updates.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@tools/redpanda-connect/rpcn-connector-docs-handler.js`:
- Around line 1135-1148: The cloud-only detection is wrong because
validConnectors entries built from dataObj lose the
connector.cloudOnly/requiresCgo flags; update the code that maps/creates
validConnectors (the place where dataObj is converted into connector objects) to
copy over connector.cloudOnly and connector.requiresCgo (or derive them from
dataObj) so that later logic in allMissing (which checks cloudOnly and uses
roots.cloudOnly vs roots.pages/roots.partials) correctly tests cloud-only
connectors; ensure the property names match what allMissing expects
(cloudOnly/requiresCgo) so cloud-only connectors are only checked in
roots.cloudOnly and treated as cloud-only by downstream drafting logic.
- Around line 1152-1193: The cloud-docs check currently only treats 404 as
"missing" and silently ignores any other errors, causing a false success; update
the loop that calls octokit.repos.getContent to record non-404 failures (e.g.,
push to a new array like cloudDocsErrors or set a flag) and include the error
details (status/message) when recording them, continue to treat 404 as missing
by adding to missingFromCloudDocs, and after the loop, if cloudDocsErrors is
non-empty print an "inconclusive" or error summary (with counts/details) instead
of the success message so non-404 API errors (401/403/rate-limit/network) are
surfaced and the check does not incorrectly report all-clear.