chore: categorize auto-generated release notes#1608
Open
jeffspahr wants to merge 1 commit intokagent-dev:mainfrom
Open
chore: categorize auto-generated release notes#1608jeffspahr wants to merge 1 commit intokagent-dev:mainfrom
jeffspahr wants to merge 1 commit intokagent-dev:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds .github/release.yml to configure GitHub's auto-generated release notes functionality. It categorizes pull requests into six categories (Features, Bug Fixes, Documentation, Testing, Dependencies, and Other Changes) based on their labels, allowing human contributions to be more prominent by placing dependency updates in a separate section. The configuration integrates with the existing generate_release_notes: true setting in the tag.yaml workflow without requiring any workflow modifications.
Changes:
- Adds a new
.github/release.ymlconfiguration file that categorizes release notes by PR labels - Defines exclusion rules for duplicate, invalid, wontfix, and stale labels
- Establishes six release note categories with corresponding label mappings
- Uses the wildcard "*" catch-all label for uncategorized changes
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Categorize auto-generated release notes to surface features and bug fixes above dependency updates. Signed-off-by: Jeff Spahr <spahrj@gmail.com>
jeffspahr
force-pushed
the
release-notes-preview
branch
from
84af909 to
0f29684
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.github/release.ymlto categorize auto-generated release notes, surfacing features and bug fixes above dependency updatesgenerate_release_notes: trueintag.yamlBefore: All PRs listed in a flat "What's Changed" list (71% dependabot noise in v0.8.3)
After: PRs grouped into Features, Bug Fixes, Documentation, Testing, Dependencies, and Other Changes
Previews
This PR implements the flat-section approach:
https://github.com/jeffspahr/kagent/releases/tag/v0.8.3
An alternative with dependencies collapsed into an expandable
<details>block is also available for comparison:https://github.com/jeffspahr/kagent/releases/tag/v0.8.3-collapsed
The collapsed approach would require additional post-processing in the release workflow since
.github/release.ymldoesn't natively support collapsible sections. We can switch to that later if preferred.Test plan