Repository navigation
Improve changelog agent output formatting - #640
Merged
Merged
Conversation
- Don't include version heading in GitHub Release notes (redundant with release title) - Omit 'Other changes' subheading when there are no highlighted features above it - Add 'New contributors' section listing first-time contributors with their PR link Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the output formatting of the release changelog agentic workflow (release-changelog.md) by making three targeted improvements: removing the redundant version heading from GitHub Release notes, conditionally omitting the ### Other changes subheading when there are no highlighted features, and adding a ### New contributors section for first-time contributors.
Changes:
- Adds instruction for identifying new contributors in Step 3 and formatting them in Step 4
- Updates Step 6 to omit the version heading from GitHub Release notes
- Extends the example output to demonstrate the new
### New contributorssection
Comments suppressed due to low confidence (2)
.github/workflows/release-changelog.md:152
- The "Key rules visible in the example" summary (lines 148–152) has been updated with a new contributors section in the example output but the summary doesn't mention the new
### New contributorsrule. The AI agent uses these key rules as a quick reference, so the omission means it may not consistently apply the new contributors section. A bullet should be added here, e.g. "A### New contributorssection lists first-time contributors with a link to their first PR; omit it if there are none."
This issue also appears on line 101 of the same file.
**Key rules visible in the example:**
- Highlighted features get their own `### Feature:` heading, a short description, and code snippets
- Code snippets are TypeScript and C# primarily; Go/Python only when listing one-liner equivalents or when meaningfully different
- The `### Other changes` section is a flat bulleted list with lowercase `bugfix:` / `feature:` / `improvement:` prefixes
- PR numbers are linked inline, not at the end with author attribution (keep it clean)
.github/workflows/release-changelog.md:101
- Step 6 instructs the agent to start the GitHub Release notes "directly with the feature sections or other changes list," but does not clarify whether the
### New contributorssection should also be included in the release notes. Based on the PR description ("matching the useful info GitHub's auto-generated notes already provided"), it seems intended to appear there too. The instruction should explicitly state whether to include it, to avoid ambiguity for the AI agent.
Use the `update-release` output to replace the auto-generated release notes with your nicely formatted changelog. **Do not include the version heading** (`## [vX.Y.Z](...) (date)`) in the release notes — the release already has a title showing the version. Start directly with the feature sections or other changes list.
SteveSandersonMS
disabled auto-merge
March 3, 2026 17:19
edburns
pushed a commit
that referenced
this pull request
Aug 4, 2026
- Don't include version heading in GitHub Release notes (redundant with release title) - Omit 'Other changes' subheading when there are no highlighted features above it - Add 'New contributors' section listing first-time contributors with their PR link Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Follow-up improvements to the release changelog agent based on initial test run:
## [vX.Y.Z]heading was redundant### Other changessubheading when there are no highlighted features above it — just list bullets directly under the version heading### New contributorssection listing first-time contributors with a link to their first PR, matching the useful info GitHub's auto-generated notes already provided