Skip to content

chore: clean up release notes generation output - #9705

Open
manolo wants to merge 1 commit into
mainfrom
chore/improve-release-notes-format
Open

chore: clean up release notes generation output#9705
manolo wants to merge 1 commit into
mainfrom
chore/improve-release-notes-format

Conversation

@manolo

@manolo manolo commented Jul 9, 2026

Copy link
Copy Markdown
Member

The generated GitHub release notes were hard to read. The Web-Component
version bumps produced one repeated line per commit, and each PR entry pasted
the whole PR body: the template sections, checklists, HTML comment hints and
trailing separators. This made the notes long and noisy, and it also published
internal template text on the public release pages.

Changes in scripts/generateChangeLog.js:

  • Web-Component version bumps are collapsed into a single bullet that links
    every commit, instead of one identical line per commit.
  • Each PR entry shows only the first paragraph of its Description or Summary
    section, followed by a (more) link to the PR when content was cut.
  • Template sections (Type of change, Checklist), checkbox items, HTML
    comments and horizontal-rule separators are removed from the output.
  • Footer references that are not issue numbers are no longer listed as tickets.

Consolidate repeated Web-Component version bumps into a single line, trim PR
bodies to the first paragraph of the description with a link to the PR for the
rest, and drop template sections, checklists, HTML comments and separators from
the output.
@sonarqubecloud

sonarqubecloud Bot commented Jul 9, 2026

Copy link
Copy Markdown

@manolo
manolo requested a review from web-padawan July 9, 2026 12:03
return /^- \[[ xX]\]/.test(line)
|| /^🤖/.test(line)
|| /generated with .*claude/i.test(line)
|| /i have read the contribution guide/i.test(line);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

question: should we remove commit message body altogether? IMO the message and PR link are enough, see e.g. release notes for 25.2.0 which I formatted manually.

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