Skip to content

Declare RDI's archived versions in doc_bundles.json - #4062

Open
EliShteinman wants to merge 1 commit into
redis:mainfrom
EliShteinman:bugfix/rdi-doc-bundles-versions
Open

EliShteinman wants to merge 1 commit into
redis:mainfrom
EliShteinman:bugfix/rdi-doc-bundles-versions

Conversation

@EliShteinman

@EliShteinman EliShteinman commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

Problem

build/test_make_doc_bundles.py::test_version_directories_require_a_versions_key fails on main:

AssertionError: redis-data-integration has archived versions in content (1.19.1) but no "versions" key
in data/doc_bundles.json. Without it the picker offers no version choice and the latest bundle
swallows every version.

DOC-7070 (f7ad0b223) restored RDI's version dropdown and archived the current docs as content/integrate/redis-data-integration/1.19.1/. It didn't touch data/doc_bundles.json, so the redis-data-integration docset still has no versions key. The test's own docstring describes the result:

  • The download picker offers no version choice for RDI.
  • iter_pages skips version directories only for docsets that declare versions, so the latest RDI bundle would include every 1.19.1 page.

Change

Add "versions": "rdi" to the redis-data-integration entry. The value names the rdi-versions file that main.yml already writes for the sidebar dropdown. It follows the same convention as rs, kubernetes, and redisvl.

Verification

  • On main, test_version_directories_require_a_versions_key fails. With this change it passes.
  • The rest of build/test_make_doc_bundles.py is unchanged: 32 passed.
  • Related, not fixed here: test_every_product_is_offered also fails on main. content/operate/radar (Radar docs #3803) is published, but no docset offers it. That needs a decision about how Radar should be offered, so this PR leaves it out.

No workflow runs the tests under build/, which is why neither failure surfaced in CI.

🤖 Generated with Claude Code


Note

Low Risk
Single manifest metadata change for downloads/version packaging; no runtime or auth impact.

Overview
Adds "versions": "rdi" to the Redis Data Integration docset in data/doc_bundles.json, matching other versioned products (rs, kubernetes, redisvl).

This wires RDI’s archived 1.19.1 content to the existing rdi-versions list from CI so the download picker can show a version dropdown and iter_pages does not fold every archived tree into the latest bundle.

Fixes test_version_directories_require_a_versions_key on main; no other build logic changes.

Reviewed by Cursor Bugbot for commit 5bd2866. Bugbot is set up for automated code reviews on this repo. Configure here.

DOC-7070 restored RDI's 1.19.1 archive but left the redis-data-integration
docset without a "versions" key. The download picker then offers no version
choice for RDI, and iter_pages, which skips version directories only for
docsets that declare one, packages 1.19.1 into the latest bundle.
test_version_directories_require_a_versions_key fails on main for exactly
this. "rdi" names the rdi-versions file main.yml already writes.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings September 19, 2026 19:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The focused manifest change addresses the documented versioning issue with no unresolved review comments.

Review effort: Lite
Findings: None

What changed in this PR

Adds version metadata for Redis Data Integration so archived documentation is handled correctly.

Changes:

  • Adds "versions": "rdi" to the RDI docset manifest.
  • Connects archived versions to the existing version-list workflow.
File Description
data/​doc_bundles.json Declares RDI’s archived-version source.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants