fix: read CHANGELOG.md from tagged commit during release#4764
Merged
Conversation
The release announcement prompt now explicitly instructs to read
the CHANGELOG.md from the tagged commit (using git show {{.Tag}}:CHANGELOG.md)
rather than from the current working directory. This ensures the release
notes match the actual release content, not any subsequent changes that
may have been made to the main/v2 branch.
Fixes issue where release announcements contained incorrect changelog
content when the CHANGELOG.md was updated after tagging.
Signed-off-by: Mark Phelps <[email protected]>
dosubot
Bot
added
the
size:XS
|
Related Documentation Checked 3 published document(s). No updates required. You have 3 draft document(s). Publish docs to keep them always up-to-date How did I do? Any feedback? |
|
Documentation Updates Checked 3 published document(s). No updates required. You have 3 draft document(s). Publish docs to keep them always up-to-date How did I do? Any feedback? |
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
1 participant
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
Fixes the issue where release announcements were reading the CHANGELOG.md from the wrong commit, resulting in incorrect or missing release notes.
Changes
.github/prompts/release.md: Updated the AI prompt to explicitly read CHANGELOG.md from the tagged commit usinggit show {{.Tag}}:CHANGELOG.mdinstead of reading from the current working directoryProblem
The previous implementation (from PR #4757) was reading the CHANGELOG.md from the current branch state during the release process. This caused issues when:
Solution
The AI prompt now explicitly instructs to read the CHANGELOG.md content from the specific Git tag being released, ensuring the release notes always match the actual release content.
Additional Notes
This ensures consistency between the tagged release and its announcement, preventing confusion when the changelog is updated post-tagging.