auto-docs: Update @redpanda-data/docs-extensions-and-macros#1726
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Feediver1
left a comment
There was a problem hiding this comment.
Docs standards review (automated dep bump, main)
Files reviewed: 1 (package-lock.json, +3/-3). Not an .adoc content PR — automated dependency-bump bot PR. Sibling of #1727 (which targets the v/24.3 branch); this one targets main.
What this PR does
Bumps @redpanda-data/docs-extensions-and-macros on main from 5.0.0 → 5.0.3. Only the lockfile changes (the package.json constraint already allows the 5.0.x range). The three patch versions that get pulled in actually carry meaningful behavior changes:
| Source PR | What landed | When |
|---|---|---|
| extensions#201 (merged 2026-06-02 16:23) | False-positive "new connector" fix (symmetric augmentation in diff-generation), prometheus {} fix in common config YAML, Self-Managed → Streaming title comparison fix, + the Python C++ numeric-constant resolver work that was supposed to live in #202 |
Produced 5.0.3 |
| extensions#199 (merged 2026-05-27) | Fix old component name in attribute replacer extension | Likely 5.0.1 or 5.0.2 |
| extensions#197 (merged 2026-05-26) | Add unified navigation extension and update component references | Likely 5.0.1 or 5.0.2 |
Critical issues
None.
Suggestions
-
5.0.0 → 5.0.3 actually carries substantive behavior changes beyond a typical patch bump:
- Connector docs generation is more accurate (no spurious "new connector" reports for CGO-only components)
- Prometheus metrics config YAML now renders with
{}instead of an empty dangling key - The Python C++ numeric-constant resolver is in (DOC-2137 territory) — property docs that referenced
DEFAULT_TOPIC_MEMORY_PER_PARTITIONwill now resolve to"200 KiB (204800)"style values when regenerated - Streaming component title comparison is fixed in the attribute replacer
So while this is technically a patch-version bump, the next time someone runs
gen-props,gen-connectors, or similar generators against main, the output may diff vs. the previous version. Worth flagging in case anyone reviewing this assumes "patch bump = no behavior change." -
What 5.0.3 does NOT contain: the
available-properties-tagandavailable-connect-versionattributes from extensions#200, which is still open. The consumer-side docs-ui#384 depends on those attributes for its fallback chain. So merging this PR doesn't unblock docs-ui#384 — both extensions#200 and docs-ui#384 still need to land. Worth knowing for cross-repo coordination. -
Same auto-merge process question as #1727 — routine dep updates with green CI sit too long. This PR is 1 day old, which is reasonable, but the v/24.3 sibling has been waiting longer.
-
PR description is minimal —
"This PR updates @redpanda-data/docs-extensions-and-macros using npm update.". A link to the source PRs that produced the new version (e.g., extensions#201) would help reviewers know what's actually changing. Out of scope here; bot-config tweak.
Impact on other files
-
No
.adoccontent changes, but the extension upgrade affects every page rendered by docs-extensions-driven mechanisms:- Connector docs pages (any auto-generated connector reference under
modules/components/) - Property docs pages (auto-generated property tables that reference C++ constants)
- Prometheus config examples in YAML callouts
- Connector docs pages (any auto-generated connector reference under
-
Worth eyeballing the deploy preview for at least:
- A connector-docs page (e.g.,
develop/connect/components/inputs/kafka_franz.adoc) - A property-reference page that uses numeric defaults (anything that historically rendered a constant name like
DEFAULT_TOPIC_MEMORY_PER_PARTITION) - A Prometheus metrics config block
to confirm the new generator output looks right.
- A connector-docs page (e.g.,
-
No nav.adoc, xrefs, or page semantics affected directly by the bump.
CodeRabbit findings
None — CodeRabbit doesn't post on package-lock-only diffs.
What works well
- All CI green, including Netlify deploy-preview. The build exercises the new extension version end-to-end.
- Single-file lockfile-only diff — easy to revert if anything regresses.
- Source PRs that produced 5.0.3 are reviewable in the extensions repo (#201) — chain of trust intact even if this PR's description is terse.
Verdict
Routine bot bump, but with meaningfully more behavior change packed in than the version delta suggests. Probably safe to merge after a one-minute deploy-preview check on a connector page + property page, knowing that ANY future gen-* regeneration on main will use the new behavior (different connector-diff handling, prometheus {}, constant resolution).
This PR updates
@redpanda-data/docs-extensions-and-macrosusingnpm update.