Add branch support to ChangeLog helper tool - #3837
Open
pljones wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the tools/changelog-helper.sh release-process helper to support checking PR references against a specified branch instead of always using main, enabling accurate ChangeLog verification for release branches (e.g. release/3_12).
Changes:
- Add a
--branchCLI option (defaulting tomain) to select which branch to check. - Pass the selected branch through to the “find/add missing entries” flow and update
--helpoutput accordingly. - Adjust git ref handling in the missing-entry scan to incorporate the selected branch.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pljones
force-pushed
the
changelog-helper-branch-support
branch
from
July 26, 2026 12:17
8491e6a to
9c69be7
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
tools/changelog-helper.sh:104
target_refis computed (and even switched to the release tag when it exists), but the subsequentgit logstill uses${branch}. This means the selected ref/tag is ignored and the output can be wrong for released versions or when the target branch only exists asorigin/<branch>. Also the "Ignoring PR" message still refers to..HEADinstead of the actual range being scanned.
echo
echo "Checking if all PR references in git log since ${prev_release_tag} are included for ${target_release} based on ref ${target_ref}..."
local milestone
for id in $(git log "${prev_release_tag}..${branch}" | grep -oP '#\K(\d+)'); do
gh pr view "${id}" --json title &> /dev/null || continue # Skip non-PRs
softins
reviewed
Jul 26, 2026
softins
left a comment
Member
There was a problem hiding this comment.
Apart from those comments, this looks sensible and in line with the existing design of the script.
pljones
force-pushed
the
changelog-helper-branch-support
branch
from
July 27, 2026 18:30
9c69be7 to
5e89019
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.
Short description of changes
I made this change when working on the release 3.12.3 changes because there were multiple fixes in the release.
As written, the tool had
mainhard coded. This change now makesmainthe default branch but allows an alternative branch to be specified -- e.g.--branch release/3_12.Tested - it no longer finds merges to main that didn't get to release/3_12.
CHANGELOG: SKIP
Context: Fixes an issue?
Release process helper update.
Does this change need documentation? What needs to be documented and how?
No. (
--helpupdated)Status of this Pull Request
Test on Release 3.12.3 ChangeLog.
What is missing until this pull request can be merged?
Should be okay to merge.
Checklist