ilusha/blender
1
0
Fork 0
mirror of https://github.com/blender/blender synced 2026-09-29 04:37:17 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Release note tools: Factor out gathering and printing of release notes information

Browse source 
This is a small refactor of part of the release notes tool so the
gathering of information that should be printed to terminal, and the
actual printing of the informaiton is split into two seperate steps.

This allows the "gathering" function to be reused by other Python
scripts. For example, the script that presents the output of the
bug fixes per release script in a friendly mannor for triagers at
https://projects.blender.org/triager-bot/needs-triager-action/issues/2
https://projects.blender.org/triager-bot/needs-triager-action/issues/3

This change should have no functional impact on the bug fixes per
release script, outside of the occasional white space change in the
output of the script.

Pull Request: https://projects.blender.org/blender/blender/pulls/149634
This commit is contained in:
Alaska 2026-01-20 15:41:05 +01:00 • committed by Philipp Oeser
parent 38b4489202
commit 03c423a55d
1 changed files with 29 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

44
release/release_notes/bug_fixes_per_major_release.py
View file

@ -767,7 +767,7 @@ def organize_commits(list_of_commits: list[CommitInfo]) -> dict[str, dict[str, l
return dict_of_sorted_commits
def print_list_of_commits(title: str, dict_of_commits: dict[str, list[CommitInfo]]) -> None:
def gather_list_of_commits_to_print(title: str, dict_of_commits: dict[str, list[CommitInfo]]) -> str:
commits_message = ""
number_of_commits = 0
unknown_module_commit_message = ""
@ -790,33 +790,47 @@ def print_list_of_commits(title: str, dict_of_commits: dict[str, list[CommitInfo
commits_message += printed_line
if number_of_commits != 0:
print(f"{title} {number_of_commits}")
print(commits_message)
print(unknown_module_commit_message)
print("\n\n\n")
return f"""{title} {number_of_commits}
{commits_message}
{unknown_module_commit_message}"""
return ""
# ---
def print_release_notes(list_of_commits: list[CommitInfo]) -> None:
def print_with_spacer(info_to_print: str) -> None:
if len(info_to_print) > 0:
print(info_to_print)
# Print spacer
print("\n\n\n")
dict_of_sorted_commits = organize_commits(list_of_commits)
print_list_of_commits("Commits that fixed old issues:", dict_of_sorted_commits[FIXED_OLD_ISSUE])
print_with_spacer(
gather_list_of_commits_to_print(
"Commits that fixed old issues:",
dict_of_sorted_commits[FIXED_OLD_ISSUE]))
print_list_of_commits(
"Revert commits. Add overrides to https://projects.blender.org/blender/blender/issues/137983:",
dict_of_sorted_commits[REVERT])
print_with_spacer(
gather_list_of_commits_to_print(
"Revert commits. Add overrides to https://projects.blender.org/blender/blender/issues/137983:",
dict_of_sorted_commits[REVERT]))
print_list_of_commits("Commits that need manual sorting:", dict_of_sorted_commits[NEEDS_MANUAL_SORTING])
print_with_spacer(
gather_list_of_commits_to_print(
"Commits that need manual sorting:",
dict_of_sorted_commits[NEEDS_MANUAL_SORTING]))
print_list_of_commits(
"Commits that need a override in https://projects.blender.org/blender/blender/issues/137983 as they claim to fix a PR:",
dict_of_sorted_commits[FIXED_PR])
print_with_spacer(
gather_list_of_commits_to_print(
"Commits that need a override in https://projects.blender.org/blender/blender/issues/137983 as they claim to fix a PR:",
dict_of_sorted_commits[FIXED_PR]))
print_list_of_commits("Ignored commits:", dict_of_sorted_commits[IGNORED])
print_with_spacer(gather_list_of_commits_to_print("Ignored commits:", dict_of_sorted_commits[IGNORED]))
# Currently disabled as this information isn't particularly useful.
# print_list_of_commits(dict_of_sorted_commits[FIXED_NEW_ISSUE])
# print(gather_list_of_commits_to_print(dict_of_sorted_commits[FIXED_NEW_ISSUE]))
print(r"""What to do with this output:
- Go through every commit in the "Commits that need manual sorting" section and: