Skip to content

Collapse the detailed changelog lists in release notes - #101

Merged
skjiisa merged 1 commit into
mainfrom
release-notes-collapse
Oct 29, 2026
Merged

skjiisa merged 1 commit into
mainfrom
release-notes-collapse

Conversation

@skjiisa

@skjiisa skjiisa commented Oct 29, 2026

Copy link
Copy Markdown
Owner

The release page now shows the install steps and the version's intro, and folds the detailed lists into a collapsed Full changelog block.

How it works

  • scripts/changelog_section.py --collapse <version> keeps everything before the section's first ### heading visible. That's the intro paragraph, or a couple of high-level bullets. It wraps the rest (Added, Changed, Fixed…) in <details><summary>Full changelog</summary>, with the blank lines GitHub needs to render Markdown inside it.
  • A section with no intro is folded entirely. A section with no ### headings is printed unchanged.
  • The release workflow passes --collapse. Without the flag the script prints the section as before.

So for 2.0.0, whatever you write between ## [2.0.0] - … and the first ### is what people see without expanding.

Testing

  • New tests/test_changelog_section.py: intro plus lists, no intro, no subheadings.
  • Ran it on the real 2.0.0-rc2 section: the intro paragraph stays visible and the Fixed list is folded.
  • The workflow itself only runs on a tag, so it wasn't run. The change there is the one flag.

🤖 Generated with Claude Code

The release page keeps the install steps and the version's intro paragraph
visible, and puts the Added/Changed/Fixed lists in a <details> block.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@skjiisa skjiisa mentioned this pull request Oct 29, 2026
@skjiisa
skjiisa merged commit 129fce7 into main Oct 29, 2026
7 checks passed
@skjiisa
skjiisa deleted the release-notes-collapse branch October 29, 2026 03:28
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