Skip to content

feat(release): fold changelog sections in release notes - #35

Merged
sdonche merged 1 commit into
mainfrom
claude/collapsible-release-notes-33370f
Oct 5, 2026
Merged

sdonche merged 1 commit into
mainfrom
claude/collapsible-release-notes-33370f

Conversation

@sdonche

@sdonche sdonche commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

Release notes now fold each ### Added / ### Changed / ### Fixed section of the CHANGELOG into a collapsible <details> block titled with its entry count. The summary above the sections stays in view. Same format as the designer dark mode module's release pages.

The change is in ops/changelog-notes.py, so release.yml is untouched. Checked by running the script on 0.3.0 and 0.3.1 and rendering the output through GitHub's Markdown API.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features
    • Release notes now include a short maker footer.
    • Added, Changed, and Fixed sections are displayed in collapsible blocks with entry counts, while the summary remains visible.

The release page opened as one long list. Each Added / Changed / Fixed
section now collapses into a <details> block titled with its entry count,
while the summary above them stays in view, matching the designer dark mode
module's release pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d20065bc-56c3-4da1-be33-7cf0811bdae5
📥 Commits

Reviewing files that changed from the base of the PR and between 4639d33 and 1320a4c.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • ops/changelog-notes.py

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review.


📝 Walkthrough

Walkthrough

The changelog note generator now wraps subsections in collapsible blocks and includes their entry counts in block summaries. The Unreleased changelog note describes the footer and collapsible sections.

Changes

Changelog note generation

Layer / File(s) Summary
Fold changelog subsections
ops/changelog-notes.py, CHANGELOG.md
The generator keeps content before the first subsection visible and wraps each subsection in a details block. Each block summary includes the subsection title and, when present, the count of lines beginning with - . Found changelog content is folded before the footer is appended. The Unreleased note describes the footer and collapsible sections.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Merge Risk: ⚪ Minimal · up to 1320a

The change updates release-note presentation, and the displayed counts match entries in the current changelog. No concrete merge-blocking issue was found.

Architecture Summary

Architecture risk: 🟡 Medium · up to 1320a

The change affects 2 systems.

Changed systems: ops, CHANGELOG.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — ops (service) was modified; 1 changed file maps to changed impact.
  • observed — CHANGELOG.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in CHANGELOG.md: The Added entry now describes both the release-notes footer and collapsible Added, Changed, and Fixed sections with entry counts, while keeping the summary visible. The previous entry mentioned only the footer.
  • observed — Modified behavior in ops/changelog-notes.py: The section docstring now specifies that ### subsections are folded into <details> blocks; previously it only described extracting the section through the next ## heading.
  • observed — Modified behavior in ops/changelog-notes.py: Adds fold, which leaves text before the first ### heading visible and wraps each heading and its following content in a <details> block. The summary includes the heading and, when present, a count of subsection lines starting with - .
  • observed — Modified behavior in ops/changelog-notes.py: Found changelog content is now passed through fold before printing; the missing-section fallback and appended footer are unchanged.

Reliability and maintainability

  • inferred — Risk-relevant change factors for ops: blast_radius_1; direct_dependents_1
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 1 files. (1 skipped: 1… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: folding changelog sections in release notes.
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.
Full details: Docstring Coverage

Explanation

Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 1 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@sdonche
sdonche merged commit 170da75 into main Oct 5, 2026
4 checks passed
@sdonche
sdonche deleted the claude/collapsible-release-notes-33370f branch October 5, 2026 11:20
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.

1 participant