Skip to content

auto-docs: Update property docs for tag v26.1.7#1693

Open
vbotbuildovich wants to merge 1 commit intomainfrom
update-property-docs-v26.1.7
Open

auto-docs: Update property docs for tag v26.1.7#1693
vbotbuildovich wants to merge 1 commit intomainfrom
update-property-docs-v26.1.7

Conversation

@vbotbuildovich
Copy link
Copy Markdown
Contributor

This PR auto-generates updated Redpanda property documentation for v26.1.7.

@vbotbuildovich vbotbuildovich requested a review from a team as a code owner May 8, 2026 12:54
@netlify
Copy link
Copy Markdown

netlify Bot commented May 8, 2026

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 8b90727
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69fddd0d3e775b0008bcfb55
😎 Deploy Preview https://deploy-preview-1693--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

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
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 8, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR documents the addition of the new oidc_http_proxy_url configuration property for Redpanda v26.1.7. The changes update the release version in Antora metadata (26.1.6 → 26.1.7), add the property schema definition with type and constraints, update version comparison tracking to record the new property, provide user-facing documentation in AsciiDoc format, and apply minor formatting cleanup to the property overrides metadata file.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • redpanda-data/docs#1679: Both PRs modify the same Antora playbook attributes (asciidoc.attributes.full-version and latest-redpanda-tag) to bump the release tag.
  • redpanda-data/docs#1666: Both PRs modify the same Antora metadata attributes in antora.yml (asciidoc.attributes.full-version and asciidoc.attributes.latest-redpanda-tag).
  • redpanda-data/docs#1655: Both PRs modify the same Antora playbook attributes (asciidoc.attributes.full-version and latest-redpanda-tag) in antora.yml.

Suggested reviewers

  • JakeSCahill
  • paulohtb6
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is incomplete. It lacks required template sections including JIRA ticket resolution, review deadline, page previews, and check categories needed for proper documentation PR tracking. Add missing template sections: Resolves JIRA ticket link, review deadline, page previews with Netlify URLs, and checkbox selections for change type (auto-generated docs would likely be Small fix).
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title accurately describes the main change: updating property documentation for version tag v26.1.7, which aligns with the changeset's primary objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-property-docs-v26.1.7

Warning

Review ran into problems

🔥 Problems

Timed out fetching pipeline failures after 30000ms


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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@antora.yml`:
- Around line 20-21: The metadata currently sets full-version: 26.1.7 and
latest-redpanda-tag: 'v26.1.7' but latest-release-commit is pointing to the
wrong SHA; update the latest-release-commit value to the correct commit SHA
b85ee3cde96881e289beb114f1fbdfe103f4c6e9 so it matches the v26.1.7 tag (look for
the latest-release-commit key in the same file and replace its value).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 804bd291-e525-42c1-8a65-e6a449b10203

📥 Commits

Reviewing files that changed from the base of the PR and between ed6ef56 and 8b90727.

📒 Files selected for processing (5)
  • antora.yml
  • docs-data/property-overrides.json
  • docs-data/redpanda-property-changes-v26.1.6-to-v26.1.7.json
  • modules/reference/attachments/redpanda-properties-v26.1.7.json
  • modules/reference/partials/properties/cluster-properties.adoc

Comment thread antora.yml
Comment on lines +20 to +21
full-version: 26.1.7
latest-redpanda-tag: 'v26.1.7'
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.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify that tag v26.1.7 exists in redpanda-data/redpanda repository
# and check if the commit hash needs updating.

# Check if tag v26.1.7 exists
echo "Checking if tag v26.1.7 exists..."
gh api repos/redpanda-data/redpanda/git/refs/tags/v26.1.7 --jq '{tag: .ref, commit: .object.sha}' 2>&1

# Get the current commit hash from the file for comparison
echo -e "\nCurrent commit hash in antora.yml: 35a825c9c1880ebeedf4c18bb8c6cceaa63566c1"

Repository: redpanda-data/docs

Length of output: 253


Update latest-release-commit to match the v26.1.7 tag.

The tag v26.1.7 exists in the Redpanda repository, but points to commit b85ee3cde96881e289beb114f1fbdfe103f4c6e9. Line 23 has latest-release-commit: '35a825c9c1880ebeedf4c18bb8c6cceaa63566c1', which does not match. Update line 23 to point to the correct commit for this release.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@antora.yml` around lines 20 - 21, The metadata currently sets full-version:
26.1.7 and latest-redpanda-tag: 'v26.1.7' but latest-release-commit is pointing
to the wrong SHA; update the latest-release-commit value to the correct commit
SHA b85ee3cde96881e289beb114f1fbdfe103f4c6e9 so it matches the v26.1.7 tag (look
for the latest-release-commit key in the same file and replace its value).

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant