Update release notes generator #2374

KJhellico · 2025-03-26T20:23:21Z

Proposed change

Update release notes generator: adjust to CHANGES.md format.

Type of change

New country/market holidays support (thank you!)
Supported country/market holidays update (calendar discrepancy fix, localization)
Existing code/documentation/test/process quality improvement (best practice, cleanup, refactoring, optimization)
Dependency update (version deprecation/pin/upgrade)
Bugfix (non-breaking change which fixes an issue)
Breaking change (a code change causing existing functionality to break)
New feature (new holidays functionality in general)

Checklist

I've followed the contributing guidelines
I've successfully run make check, all checks and tests are green

coderabbitai · 2025-03-26T20:23:30Z

Summary by CodeRabbit

Style
- Updated the release notes header to use a hash prefix for a cleaner version display.
Documentation
- Streamlined documentation text for improved clarity.

Walkthrough

The pull request updates the header formatting in the release notes generation script and refines the docstring for the ReleaseNotesGenerator class. The header format now starts with a hash symbol (# Version {version}) instead of using an underline style. Additionally, the class docstring was updated by removing an unnecessary newline. There are no changes to exported or public declarations.

Changes

File(s)	Change Summary
`scripts/generate_release_notes.py`	Updated release notes header from the multiline format (`Version {version}` followed by underlines) to a Markdown header (`# Version {version}`) and consolidated the docstring for the `ReleaseNotesGenerator` class by removing a newline.

Suggested Reviewers

arkid15r
PPsyrius

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a9fce3c and 0c9e51c.

📒 Files selected for processing (1)

scripts/generate_release_notes.py (2 hunks)

⏰ Context from checks skipped due to timeout of 300000ms (1)

GitHub Check: Test build on windows-latest

🔇 Additional comments (2)

scripts/generate_release_notes.py (2)

31-34: Update release notes header format
The header template now starts with a hash symbol (# Version {version}) to align with the CHANGES.md format. This update improves consistency with the expected release notes style while keeping the functionality intact.

40-43: Refine ReleaseNotesGenerator docstring
The revised docstring for the ReleaseNotesGenerator class removes an unnecessary newline, consolidating the description into a more concise format. This minor cleanup makes the documentation clearer and more in line with standard practices.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

sonarqubecloud · 2025-03-26T20:24:23Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

codecov · 2025-03-26T20:24:49Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a9fce3c) to head (0c9e51c).
Report is 3 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff            @@
##               dev     #2374   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          204       204           
  Lines        12853     12853           
  Branches      1817      1817           
=========================================
  Hits         12853     12853

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

arkid15r

LGTM

PPsyrius

LGTM 🛠️

Update release notes generator

0c9e51c

KJhellico requested review from arkid15r and PPsyrius as code owners March 26, 2025 20:23

github-actions bot added the script label Mar 26, 2025

arkid15r reviewed Mar 26, 2025

View reviewed changes

arkid15r enabled auto-merge March 26, 2025 22:45

PPsyrius approved these changes Mar 27, 2025

View reviewed changes

arkid15r added this pull request to the merge queue Mar 27, 2025

Merged via the queue into vacanza:dev with commit 31a5f7f Mar 27, 2025
33 checks passed

KJhellico deleted the upd-release-generator branch March 27, 2025 11:27

arkid15r mentioned this pull request Apr 7, 2025

v0.70 #2443

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Update release notes generator #2374

Update release notes generator #2374

Uh oh!

KJhellico commented Mar 26, 2025

Uh oh!

coderabbitai bot commented Mar 26, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

sonarqubecloud bot commented Mar 26, 2025

Uh oh!

codecov bot commented Mar 26, 2025 •

edited

Loading

Uh oh!

arkid15r left a comment

Uh oh!

PPsyrius left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Update release notes generator #2374

Update release notes generator #2374

Uh oh!

Conversation

KJhellico commented Mar 26, 2025

Proposed change

Type of change

Checklist

Uh oh!

coderabbitai bot commented Mar 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Walkthrough

Changes

Suggested Reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

sonarqubecloud bot commented Mar 26, 2025

Quality Gate passed

Uh oh!

codecov bot commented Mar 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

arkid15r left a comment

Choose a reason for hiding this comment

Uh oh!

PPsyrius left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot commented Mar 26, 2025 •

edited

Loading

codecov bot commented Mar 26, 2025 •

edited

Loading