-
-
Notifications
You must be signed in to change notification settings - Fork 14
Add release notes configuration #971
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.
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
Conversation
Add a configuration file for generating GitHub release notes. See https://docs.github.com/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR modernizes the release notes generation process by replacing custom JavaScript filtering logic with GitHub's native release notes configuration. The changes move from manual API calls and string manipulation to using GitHub's built-in generate_release_notes feature with a declarative configuration file.
- Replaces manual release notes generation and bot filtering with GitHub's native
generate_release_notesparameter - Adds a
.github/release.ymlconfiguration file to exclude bot accounts from release notes - Simplifies the release workflow by removing custom JavaScript filtering logic
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.github/workflows/release.yml |
Removes manual release notes generation code and enables GitHub's automatic generation |
.github/release.yml |
Adds release notes configuration to exclude bot authors from changelog |
| - dependabot[bot] | ||
| - costellobot | ||
| - costellobot[bot] | ||
| - github-actions[bot] |
Copilot
AI
Jul 22, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The author exclusion list includes both 'costellobot' and 'costellobot[bot]'. Consider whether both entries are necessary, as GitHub typically uses the '[bot]' suffix for bot accounts. Review your repository's commit history to confirm which format is actually used.
| - dependabot[bot] | |
| - costellobot | |
| - costellobot[bot] | |
| - github-actions[bot] | |
| - dependabot[bot] | |
| - costellobot[bot] | |
| - github-actions[bot] |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #971 +/- ##
=======================================
Coverage 98.59% 98.59%
=======================================
Files 16 16
Lines 284 284
Branches 37 37
=======================================
Hits 280 280
Misses 2 2
Partials 2 2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Add a configuration file for generating GitHub release notes.
See Configuring automatically generated release notes.