tools/changelog-helper: Ignore foreign-milestone PRs despite mentions in git log #2661
Conversation
… in git log Previously, all PRs from the relevant git log were added to the ChangeLog. This causes false positives when older PRs are intentionally mentioned again (e.g. for further fixes or documentation updates). At the same time, simply skipping them removes an additional method to avoid forgotten PRs. Therefore, only add git-mentioned PRs if they don't have a milestone (or a matching one). Fixes: jamulussoftware#2657
| @@ -44,9 +44,15 @@ find_or_add_missing_entries() { | |||
| target_ref="${target_release_tag}" | |||
There was a problem hiding this comment.
Should this be local?
Also, I see here we're fishing in ChangeLog for the version and asserting that uses the \d+\.... format (unlike the tag). All of this stuff needs documenting clearly in https://jamulus.io/contribute/Release-Process
("clearly" explaining why certain things should be done, so that if they need changing, how to change this script (and others like it) can be understood.)
There was a problem hiding this comment.
Should this be
local?
Yes. Updated (although unrelated to the changes here).
Also, I see here we're fishing in
ChangeLogfor the version and asserting that uses the\d+\.... format (unlike the tag). All of this stuff needs documenting clearly in https://jamulus.io/contribute/Release-Process("clearly" explaining why certain things should be done, so that if they need changing, how to change this script (and others like it) can be understood.)
Yes, all of the versioning details would benefit from clear specifications and maybe some overhauls as well.
Short description of changes
Previously, all PRs from the relevant git log were added to the ChangeLog. This causes false positives when older PRs are intentionally mentioned again (e.g. for further fixes or documentation updates). At the same time, simply skipping them removes an additional method to avoid forgotten PRs.
Therefore, only add git-mentioned PRs if they don't have a milestone (or a matching one).
CHANGELOG: Internal: Improved Changelog PR listings to avoid mistakenly listing already released PRs.
Context: Fixes an issue?
Fixes: #2657
Does this change need documentation? What needs to be documented and how?
No.
Status of this Pull Request
Ready.
What is missing until this pull request can be merged?
Reviews.
Checklist
-> Ignoring PR #1873, which was mentioned in 'git log r3_8_2..HEAD', but already has milestone 'Release 3.8.1'