Fix release notes generator to exclude PRs from previous release beta and patches #5758
+79
−35
Conversation
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
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a bug in the release notes generator where pull requests from previous release beta versions were incorrectly appearing in new release notes due to the backmerge workflow between beta and dev branches.
Key Changes:
- Refactored PR collection logic to use a generic
_collect_prs_from_tags()helper method - Renamed
_get_patch_release_prs()to_get_previous_release_prs()and extended it to collect PRs from both beta releases and patch releases - Updated
discover_prs()to exclude all PRs from the previous release cycle (betas + patches), not just patches
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
swoboda1337
approved these changes
Dec 10, 2025
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.
Description:
Fixes a bug in the release notes generator where PRs that were already included in the previous release cycle would incorrectly appear in the new release's notes.
The Problem:
When generating release notes for version 2025.12.0, the script compares
2025.11.5...2025.12.0b1. This comparison shows commits reachable from2025.12.0b1but not from2025.11.5.Due to the backmerge workflow (merging
betaintodevafter releases), commits from the previous beta cycle are in dev's history. Since2025.11.5is on thereleasebranch and2025.12.0b1is ondev, PRs that were in the 2025.11.0 betas appear as "new" commits even though they were already released.The Fix:
_get_patch_release_prs()to_get_previous_release_prs()Example:
beta→devbackmerge, the commit appears ingit log 2025.11.5...2025.12.0b1Related issue (if applicable): N/A
Pull request in esphome with YAML changes (if applicable): N/A
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/_index.mdwhen creating new documents for new components or cookbook. (N/A - script change only)