From: Freddy Date: Fri, 19 May 2023 14:04:14 +0000 (+0200) Subject: Simplify release note generator X-Git-Url: https://git.rm.cloudns.org/?a=commitdiff_plain;h=18aeaf543d5f1206b14513751b90315beb59d944;p=xonotic%2Fxonotic.git Simplify release note generator --- diff --git a/misc/infrastructure/MR_template.md b/misc/infrastructure/MR_template.md index 13146ecf..ec959acd 100644 --- a/misc/infrastructure/MR_template.md +++ b/misc/infrastructure/MR_template.md @@ -1,10 +1,8 @@ Summary for release notes: --- -Write a short summary for the release notes here (one or two sentences) +Replace this line with a short summary for the release notes here (one or two sentences). Keep the empty line after this line. -Bug introduced in MR (for 'Bug fix for git' types only): !xxxx - -[ ] I have labeled the merge request with the right 'Changelog', 'MR Type' and 'MR Size' labels +[ ] I have labeled the merge request with the right `RN:: [SECTION]`, `MR Type` and `MR Size` labels. In depth description: --- diff --git a/misc/infrastructure/prepare_releasenotes.py b/misc/infrastructure/prepare_releasenotes.py index 69be01d8..0532a7e4 100644 --- a/misc/infrastructure/prepare_releasenotes.py +++ b/misc/infrastructure/prepare_releasenotes.py @@ -9,66 +9,10 @@ import json # end remove after testing -# value indicates prio, lower prio is prefered in RN if more than one topic is given -# TODO: these topics are overlapping and also too specific -TOPIC = Enum("TOPIC", {"Accessibility": 1, - "Audio": 2, - "Balance": 3, - "Bots": 4, - "Build": 5, - "Campaign": 6, - "Client": 7, - "Configuration": 8, - "Console": 9, - "Documentation": 10, - "Engine": 11, - "Gamelogic": 12, - "Gameplay": 13, - "HUD": 14, - "Input": 15, - "Mapping": 16, - "Menu": 17, - "Moderation": 18, - "Network": 19, - "Performance": 20, - "Physics": 21, - "Rendering": 22, - "Server": 23, - "Shaders & Textures": 24, - "Stats": 25, - "Turrets": 26, - "Tutorial": 27, - "Vehicles": 28, - "Weapons": 29, - "i18n (translations)": 30, - "NO_TOPIC": 9999}) -# TODO: use these instead -SECTION = Enum("SECTION", {"Gameplay": 1, - "Balance": 2, - "Mapping": 3, - "Assets": 4, - "Menu": 5, - "Client": 6, - "Server": 7, - "Bots": 8, - "Stats": 9, - "Engine": 10, - "i18n (translations)": 11, - "Documentation": 12, - "Infrastructure": 13, - "NO_SECTION": 9999}) - -MR_TYPE = Enum("MR_TYPE", {"Bug fix": 1, - "Refactor": 2, - "UNKNOWN_TYPE": 9999}) -# TODO: use these instead -#MR_TYPE = Enum("MR_TYPE", {"Feature/Addition": 1, -# "Change": 2, -# "Bug fix for latest release": 3, -# "Bug fix for git": 4, -# "Refactor": 5, -# "Misc": 6, -# "UNKNOWN_TYPE": 9999}) +MR_TYPE = Enum("MR_TYPE", {"Feature(s)": 1, + "Fix(es)": 2, + "Refactoring": 3, + "NO_TYPE_GIVEN": 9999}) # for ordering MR_SIZE = Enum("MR_SIZE", {"Enormous": 1, @@ -79,10 +23,9 @@ MR_SIZE = Enum("MR_SIZE", {"Enormous": 1, "UNKNOWN": 6}) TOPIC_PREFIX = "Topic: " -CHANGELOG_PREFIX = "Changelog::" -MR_TYPE_PREFIX = "MR Type: " +CHANGELOG_PREFIX = "RN::" +MR_TYPE_PREFIX = "MR Content: " MR_SIZE_PREFIX = "MR Size::" -BUGFIX_REFERENCE_PREFIX = "Bug introduced in MR (for 'Bug fix for git' types only): " MAIN_PROJECT_ID = 73434 EXCLUDED_PROJECT_IDS = [] @@ -96,14 +39,10 @@ GROUP_BASEURL = BASEURL + f"/groups/{GROUP_NAME}" class MergeRequestInfo(NamedTuple): iid: int - mr_type: MR_TYPE size: MR_SIZE - topic: TOPIC - section: SECTION author: str short_desc: str web_url: str - reference: int def get_time_of_latest_release() -> str: @@ -117,13 +56,13 @@ def get_merge_requests(timestamp: str) -> list[dict]: with open("testdata.json") as f: return json.load(f) page_len = 10 - MAX_PAGES = 1 # TODO: increase after testing - url = GROUP_BASEURL + f"/merge_requests?state=merged&updated_after=" +\ - f"{timestamp}&per_page={page_len}&page=" + MAX_PAGES = 100 + url = GROUP_BASEURL + "/merge_requests?state=merged&updated_after=" +\ + f"{timestamp}&per_page={page_len}&page=" current_page = 1 data = [] while True: - response = requests.get(url+str(current_page)) + response = requests.get(url + str(current_page)) new_data = response.json() if not new_data: break @@ -136,57 +75,41 @@ def get_merge_requests(timestamp: str) -> list[dict]: return data -def process_description(description: str, mr_type: MR_TYPE) -> tuple[str, int]: +def process_description(description: str) -> str: if not description: raise ValueError("Empty description") lines = description.splitlines() if not lines[0].strip() == "Summary for release notes:": raise ValueError("Unexpected description format: Summary missing") summary = "" - cursor = 0 - for i, line in enumerate(lines[1:]): + for line in lines[1:]: if line.startswith("---"): continue if not line: - cursor = i break summary += line + " " # add space - if mr_type != MR_TYPE["Bug fix"]: # should be "Bug fix for git" - return summary.strip(), 0 - reference = 0 - for line in lines[cursor:]: - if line.startswith(BUGFIX_REFERENCE_PREFIX): - temp = line.removeprefix(BUGFIX_REFERENCE_PREFIX).strip().lstrip("!") - if not temp.isdecimal(): - logging.warning("Expected a number as MR reference, found " - f"'{temp}'") - reference = temp - else: - reference = int(temp) - break - return summary.strip(), reference + return summary.strip() -def process(data: list[dict]) -> list[MergeRequestInfo]: +def process(data: list[dict]) -> dict[MR_TYPE, dict[str, MergeRequestInfo]]: # extract type, size and topic from labels for easier filtering/ordering - # extract reference (for bugfix for git) and short description from description + # extract short description from description # extract author->name - processed_data = [] + processed_data = {mr_type: {} for mr_type in MR_TYPE} for item in data: if item["project_id"] in EXCLUDED_PROJECT_IDS: continue if item["target_branch"] not in TARGET_BRANCHES: continue - mr_type = MR_TYPE.UNKNOWN_TYPE + mr_type = MR_TYPE.NO_TYPE_GIVEN size = MR_SIZE.UNKNOWN - topic = TOPIC.NO_TOPIC - section = SECTION.NO_SECTION + section = "UNKNOWN SECTION" for label in item["labels"]: if label.startswith(MR_TYPE_PREFIX): try: new_mr_type = MR_TYPE[label.removeprefix(MR_TYPE_PREFIX)] - except KeyError as e: + except KeyError: logging.warning(f"Unexpected label: {label}, skipping") continue if new_mr_type.value < mr_type.value: @@ -195,86 +118,46 @@ def process(data: list[dict]) -> list[MergeRequestInfo]: if label.startswith(MR_SIZE_PREFIX): try: new_size = MR_SIZE[label.removeprefix(MR_SIZE_PREFIX)] - except KeyError as e: + except KeyError: logging.warning(f"Unexpected label: {label}, skipping") continue if new_size.value < size.value: size = new_size continue - if label.startswith(TOPIC_PREFIX): - try: - new_topic = TOPIC[label.removeprefix(TOPIC_PREFIX)] - except KeyError as e: - logging.warning(f"Unexpected label: {label}, skipping") - continue - if new_topic.value < topic.value: - topic = new_topic - continue if label.startswith(CHANGELOG_PREFIX): - try: - new_section = SECTION[label.removeprefix(CHANGELOG_PREFIX)] - except KeyError as e: - logging.warning(f"Unexpected label: {label}, skipping") - continue - if new_section.value < section.value: - section = new_section + section = label.removeprefix(CHANGELOG_PREFIX) continue - # TODO: uncomment once new MR Type labels are used - #if mr_type == MR_TYPE.Misc: - # continue try: - short_desc, referenced_mr = process_description(item["description"], - mr_type) + short_desc = process_description(item["description"]) except ValueError as e: logging.warning(f"Error processing the description for " f"{item['iid']}: {e}") short_desc = item["title"] - referenced_mr = 0 author = item["author"]["name"] - processed_data.append(MergeRequestInfo(iid=item["iid"], - mr_type=mr_type, - size=size, - topic=topic, - section=section, - author=author, - short_desc=short_desc, - web_url=item["web_url"], - reference=referenced_mr)) - processed_data.sort(key=lambda x: x.size.value) + if section not in processed_data[mr_type]: + processed_data[mr_type][section] = [] + processed_data[mr_type][section].append(MergeRequestInfo( + iid=item["iid"], size=size, author=author, + short_desc=short_desc, web_url=item["web_url"])) return processed_data -def draft_releasenotes(fp: TextIO, data: list[MergeRequestInfo]) -> None: +def draft_releasenotes(fp: TextIO, data: dict[MR_TYPE, dict[str, MergeRequestInfo]]) -> None: fp.writelines(["Release Notes\n", "===\n", "\n"]) - for mr_type in MR_TYPE: + for mr_type, sectioned_mr_data in data.items(): type_written = False - #for section in SECTION: - for topic in TOPIC: + for section, merge_requests in sectioned_mr_data.items(): formatted_items = [] - #filtered = filter(lambda x: x.mr_type==mr_type and x.section==section, - # data) - filtered = filter(lambda x: x.mr_type==mr_type and x.topic==topic, - data) - for item in filtered: - if item.reference != 0: - continue + merge_requests.sort(key=lambda x: x.size.value) + for item in merge_requests: authors = item.author - referenced_by = filter(lambda x: x.reference==item.iid, data) - fix_authors = set() - for other_mr in referenced_by: - fix_authors.append(other_mr.author) - if item.author in fix_authors: - fix_authors.remove(item.author) - if fix_authors: - authors += ", fixes by " + ", ".join(fix_authors) formatted_items.append(f"- {item.short_desc} by {authors} " f"([{item.iid}]({item.web_url}))\n") if formatted_items: if not type_written: fp.writelines([f"{mr_type.name}\n", "---\n"]) type_written = True - #fp.writelines([f"### {section.name}\n", *formatted_items]) - fp.writelines([f"### {topic.name}\n", *formatted_items]) + fp.writelines([f"### {section}\n", *formatted_items]) fp.write("\n")