Skip to content

Fix/sync mkdocs major section spock v6 - #129

Merged
susan-pgedge merged 2 commits into
mainfrom
fix/sync-mkdocs-major-section-spock-v6
Jul 9, 2026
Merged

Fix/sync mkdocs major section spock v6#129
susan-pgedge merged 2 commits into
mainfrom
fix/sync-mkdocs-major-section-spock-v6

Conversation

@maqeel75

@maqeel75 maqeel75 commented Jul 9, 2026

Copy link
Copy Markdown
Member
  • Fixes workflow to detect multiple major versions of Spock

  • Adds new products Spock v6 and Supautils

Summary by CodeRabbit

  • New Features

    • Added support for additional documentation versions and product sections, including new entries for Spock v6 and supautils.
    • Improved navigation handling so major version groupings are recognized correctly in generated docs reports.
  • Bug Fixes

    • Fixed drift detection so new major documentation sections are no longer treated as missing content.
    • Updated clean/no-drift checks to account for newly introduced major sections.

maqeel75 added 2 commits July 9, 2026 12:54
Products split into per-major sections (e.g. 'Spock v5') share one repo
URL, so a new major (v6.0.0-beta.1) was sorted into the v5 block. Scan
the major named in each section header and, for products in an explicit
MAJOR_SPLIT_PRODUCTS allowlist (Spock for now), report a version whose
major has no matching section as NEW SECTION for manual placement rather
than auto-inserting it into the wrong major. Add the allowlist so future
major-split products are onboarded with a one-line change. Also add the
Spock v6 nav section and landing tile.
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The mkdocs sync workflow adds a MAJOR_SPLIT_PRODUCTS allowlist and header-parsing logic to detect when a version's major requires a new nav section, tracked via new_sections, affecting drift reports and clean gating. Separately, mkdocs.yml adds spock-v6 and supautils versioned docsets, nav entries, and updates Spock v5's Development branch.

Changes

Sync workflow major-split detection

Layer / File(s) Summary
Major-split product configuration and header parsing
.github/workflows/sync-mkdocs.yml
Defines MAJOR_SPLIT_PRODUCTS allowlist (starting with Spock) and parses nav section headers into url_header_majors to track existing majors per URL.
Comparison logic and new_sections classification
.github/workflows/sync-mkdocs.yml
Adds new_sections accumulator; SSOT comparison loop detects missing majors and appends to new_sections, skipping missing/new product logic for those entries.
Drift report and clean gating updates
.github/workflows/sync-mkdocs.yml
Updates clean flag to treat new_sections as drift, adds "New major sections" report subsection, and includes new_sections count in summary.

Estimated code review effort: 3 (Moderate) | ~25 minutes

mkdocs.yml versioned docset additions

Layer / File(s) Summary
Spock v6 docset and navigation
mkdocs.yml
Adds spock-v6 to versioned_docsets, adds Spock v6 nav dropdown item, introduces Spock v6 docset section (v6.0.0-beta, Development imports), and changes Spock v5's Development branch to v5_STABLE.
supautils docset and navigation
mkdocs.yml
Adds supautils to versioned_docsets and third_party_docsets, adds supautils nav dropdown item, and introduces supautils docset section (v3.2.2, Development imports).

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • pgEdge/pgedge-docs#69: Both PRs modify mkdocs.yml versioned documentation/nav imports, including Spock version entries.
  • pgEdge/pgedge-docs#83: Both PRs modify .github/workflows/sync-mkdocs.yml drift detection/sync logic, extending nav classification and reporting.
  • pgEdge/pgedge-docs#98: Both PRs modify the same sync-mkdocs.yml drift-detection script's nav parsing/comparison logic and report/clean gating.

Suggested reviewers: imtiazqa, AntTheLimey, susan-pgedge

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly reflects the main change: updating mkdocs sync handling for Spock v6 major sections.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/sync-mkdocs-major-section-spock-v6

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

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

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 `@mkdocs.yml`:
- Around line 625-628: The Spock v6 mkdocs import is pointing at a non-existent
Git ref, so the `!import` for the `Spock v6` entry will fail. Update the
`v6.0.0-beta` import in `mkdocs.yml` to use a real branch or tag that exists in
`pgEdge/spock`, keeping the `Spock v6` navigation entry and `!import` syntax
intact.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 3f0f9b0f-d41b-4ff3-a0cb-37e43594bae0

📥 Commits

Reviewing files that changed from the base of the PR and between 9e89ce4 and fc0825b.

📒 Files selected for processing (2)
  • .github/workflows/sync-mkdocs.yml
  • mkdocs.yml

Comment thread mkdocs.yml
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying pgedge-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: fc0825b
Status: ✅  Deploy successful!
Preview URL: https://8fc3a27a.pgedge-docs.pages.dev
Branch Preview URL: https://fix-sync-mkdocs-major-sectio.pgedge-docs.pages.dev

View logs

@maqeel75
maqeel75 requested a review from susan-pgedge July 9, 2026 08:34
@susan-pgedge
susan-pgedge merged commit 30a124d into main Jul 9, 2026
4 checks passed
@maqeel75
maqeel75 deleted the fix/sync-mkdocs-major-section-spock-v6 branch July 9, 2026 10:57
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