+
Skip to content

Update release notes generator #2802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Aug 12, 2025
Merged

Update release notes generator #2802

merged 1 commit into from
Aug 12, 2025

Conversation

KJhellico
Copy link
Collaborator

Proposed change

Update release notes generator: skip IGNORED_CONTRIBUTORS also as committers.

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

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 12, 2025 •
edited
Loading

Summary by CodeRabbit

  • Chores
    • Improved release notes generator to store and render per-PR title and byline for clearer, more structured notes.
    • Excludes known bot accounts from contributor lists for cleaner attribution.
    • More robust handling of missing commit author data to prevent generation errors.
    • Updated sorting and printing logic to align with the new structure.
    • No impact to product functionality.

Walkthrough

Updated ReleaseNotesGenerator to store per-PR data as (title, byline) tuples instead of strings, adjusted contributor collection to ignore bot accounts safely, and updated sorting/rendering to use tuple indices.

Changes

Cohort / File(s) Summary
Release notes script
scripts/generate_release_notes.py		 Change pull_requests type from dict[int, str] to dict[int, tuple[str, str]]; update storage, sorting, and rendering to use tuple (title, byline); refine contributor collection using walrus operator and IGNORED_CONTRIBUTORS filter to avoid None and bots.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested labels

script

Suggested reviewers

  • 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 24149f6 and 44206b0.

📒 Files selected for processing (1)
  • scripts/generate_release_notes.py (2 hunks)
🔇 Additional comments (2)
scripts/generate_release_notes.py (2)

85-85: Tuple migration for pull_requests looks good.

Storing (title, byline) is consistent with downstream usage via pr[0]/pr[1]. Sorting and rendering align with the new shape.

148-154: Confirm intent: do we also want to consider commit.committer?

You now ignore IGNORED_CONTRIBUTORS when collecting commit authors. If the goal is to “skip IGNORED_CONTRIBUTORS also as committers,” you may want to consider commit.committer as well (some bots appear there). If you do, this patch keeps behavior for authors and additionally filters committers.

Apply this diff if committers should be credited/filtered too:

 for commit in pull_request.get_commits():
-    if (
-        commit.author
-        and (author_login := commit.author.login) not in IGNORED_CONTRIBUTORS
-    ):
-        contributors.add(author_login)
+    if (
+        commit.author
+        and (author_login := commit.author.login) not in IGNORED_CONTRIBUTORS
+    ):
+        contributors.add(author_login)
+    # Also filter/credit committers if desired.
+    if (
+        commit.committer
+        and (committer_login := commit.committer.login) not in IGNORED_CONTRIBUTORS
+    ):
+        contributors.add(committer_login)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

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

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.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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 SonarQubeCloud
Copy link

Quality Gate Passed 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 Codecov
Copy link

codecov bot commented Aug 12, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (24149f6) to head (44206b0).
⚠️ Report is 1 commits behind head on dev.

Additional details and impacted files 
@@            Coverage Diff            @@
##               dev     #2802   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          284       284           
  Lines        17049     17049           
  Branches      2253      2253           
=========================================
  Hits         17049     17049

☔ 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
arkid15r approved these changes Aug 12, 2025
View reviewed changes
Copy link
Collaborator

@arkid15r arkid15r left a comment

Choose a reason for hiding this comment

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

LGTM

// verified manually @github-actions[bot] is getting filtered out.

@arkid15r arkid15r added this pull request to the merge queue Aug 12, 2025
Merged via the queue into vacanza:dev with commit d17ddae Aug 12, 2025
36 checks passed
@KJhellico KJhellico deleted the upd-release-generator branch August 13, 2025 09:46
@arkid15r arkid15r mentioned this pull request Aug 18, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arkid15r arkid15r arkid15r approved these changes

@PPsyrius PPsyrius Awaiting requested review from PPsyrius PPsyrius is a code owner

Assignees

No one assigned

Labels

script

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@KJhellico @arkid15r
点击 这是indexloc提供的php浏览器服务，不要输入任何密码和下载