Update release notes generator #2929
Conversation
Summary by CodeRabbit
WalkthroughUpdates GitHub authentication in the release notes script to use PyGithub’s Auth.Token via Github(auth=Auth.Token(...)) instead of passing the token directly. No other logic or public interfaces are changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Suggested labels
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 Ruff (0.12.2)scripts/generate_release_notes.py�[1;31mruff failed�[0m Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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. Comment |
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #2929 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 296 296
Lines 17593 17593
Branches 2270 2270
=========================================
Hits 17593 17593 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
scripts/generate_release_notes.py(2 hunks)
⏰ Context from checks skipped due to timeout of 300000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Test docs build
- GitHub Check: Build distribution
🔇 Additional comments (1)
scripts/generate_release_notes.py (1)
23-23: Auth import: require PyGithub ≥ 1.59.0 (or add a tiny compat shim)Auth was introduced in PyGithub v1.59.0 (June 22, 2023). I found pyproject.toml and tox.ini but no pygithub entry — confirm where PyGithub is declared and pin >=1.59.0 in your dependency file(s) or add this compat shim:
-from github import Auth, Github +try: + from github import Auth, Github +except ImportError: + from github import Github + Auth = None # type: ignore[assignment]
Proposed change
Update release notes generator (update Github auth method).
Type of change
holidaysfunctionality in general)Checklist
make checklocally; all checks and tests passed.