Skip to content

doc: automate author wrapping and punctuation normalization in releas…#1058

Merged
romani merged 2 commits intocheckstyle:masterfrom
nexpectArpit:fix-releasenotes-formatting
Apr 9, 2026
Merged

doc: automate author wrapping and punctuation normalization in releas…#1058
romani merged 2 commits intocheckstyle:masterfrom
nexpectArpit:fix-releasenotes-formatting

Conversation

@nexpectArpit
Copy link
Copy Markdown
Contributor

@nexpectArpit nexpectArpit commented Apr 6, 2026

fixes #865

This PR focused on updates the releasenotes-builder tool to automatically generate release notes that comply with Checkstyle's project documentation standards. This eliminates the need for manual reformatting of releasenotes.xml after generation.

@romani please review it .

@nexpectArpit nexpectArpit marked this pull request as ready for review April 6, 2026 21:47
Copy link
Copy Markdown
Member

@romani romani left a comment

Choose a reason for hiding this comment

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

One item to be sure it works great

@Test
public void testFormatting() throws Exception {
addCommit("Issue #1: Title 1..", "Author 1, Author 2, Author 3, Author 4, Author 5, "
+ "Author 6, Author 7, Author 8, Author 9, Author 10");
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.

Please add one more tests and make "Author 8" to be "Authorloooooooongname" to see that logic will wrap it in good way, new line is expected before this long name.

@romani
Copy link
Copy Markdown
Member

romani commented Apr 7, 2026

Please review CI failures and fix them.

Thanks a lot for help.

@nexpectArpit
Copy link
Copy Markdown
Contributor Author

@romani take a look!

Copy link
Copy Markdown
Member

@romani romani left a comment

Choose a reason for hiding this comment

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

Thanks a lot

@romani romani merged commit 9230b98 into checkstyle:master Apr 9, 2026
9 checks passed
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.

releasenotes-builder: spaces and line length issue

2 participants