MaaAssistantArknights/tools/gitlog2changelog.py

import os
import json
import re

# 期待有人能实现一个更好的 contributor 名字处理方案！
contributors = {
    "@[Yifan Liu]": "@liuyifan-eric",
    "@[ABA2396]": "@ABA2396",
    "@[uye]": "@ABA2396",
    "@[Horror Proton]": "@horror-proton",
    "@[zzyyyl]": "@zzyyyl",
    "@[MistEO]": "@MistEO",
    "@[dantmnf]": "@dantmnf",
    "@[Hao Guan]": "@hguandl",
    "@[lincer_x42]": "@LCAR979",
    "@[LambdaLe]": "@WLLEGit",
    "@[KevinT3Hu]": "@KevinT3Hu",
}

# dfs 建树，Merge commit 是非叶子节点
def build_commits_tree(commit_hash: str):
    res = {}
    if commit_hash not in raw_commits_info:
        return res
    raw_commit_info = raw_commits_info[commit_hash]
    if "visited" in raw_commit_info:
        return res
    raw_commit_info.update({"visited": True})
    commit_key = raw_commit_info["message"] + f" ({raw_commit_info['hash']})" + f" @[{raw_commit_info['author']}]"
    res[commit_key] = {}
    res.update(build_commits_tree(raw_commit_info["parent"][0]))
    if len(raw_commit_info["parent"]) == 2:
        if commit_key.startswith("Release"):
            # 避免合并之后只有一个 Release 主 commit
            res.update(build_commits_tree(raw_commit_info["parent"][1]))
        else:
            res[commit_key].update(build_commits_tree(raw_commit_info["parent"][1]))
        if commit_key.startswith("Merge branch") and not res[commit_key]:
            res.pop(commit_key)
    return res

def print_commits(commits: dict, indent: str = "", need_sort: bool = True) -> (str, list):
    if not commits: return ("", [])
    ret_message = ""
    ret_contributor = []

    sorted_commits = {
        "perf": {},
        "feat": {},
        "fix": {},
        "other": {},
    }
    if need_sort and indent == "":
        for x in commits.keys():
            if False:
                pass
            elif x.find("新增") != -1:
                sorted_commits["feat"][x] = commits[x]
            elif x.find("改进") != -1 or x.find("更新") != -1 or x.find("优化") != -1 or x.find("重构") != -1:
                sorted_commits["perf"][x] = commits[x]
            elif x.find("修复") != -1:
                sorted_commits["fix"][x] = commits[x]
            elif x.startswith("feat"):
                sorted_commits["feat"][x] = commits[x]
            elif x.startswith("perf"):
                sorted_commits["perf"][x] = commits[x]
            elif x.startswith("fix"):
                sorted_commits["fix"][x] = commits[x]
            else:
                sorted_commits["other"][x] = commits[x]

        if sorted_commits["feat"]:
            ret_message += "\n### 新增\n\n"
            mes, ctrs = print_commits(sorted_commits["feat"], "", False)
            ret_message += mes
            for ctr in ctrs:
                if ret_contributor.count(ctr) == 0:
                    ret_contributor.append(ctr)

        if sorted_commits["perf"]:
            ret_message += "\n### 改进\n\n"
            mes, ctrs = print_commits(sorted_commits["perf"], "", False)
            ret_message += mes
            for ctr in ctrs:
                if ret_contributor.count(ctr) == 0:
                    ret_contributor.append(ctr)
        if sorted_commits["fix"]:
            ret_message += "\n### 修复\n\n"
            mes, ctrs = print_commits(sorted_commits["fix"], "", False)
            ret_message += mes
            for ctr in ctrs:
                if ret_contributor.count(ctr) == 0:
                    ret_contributor.append(ctr)
        if sorted_commits["other"]:
            ret_message += "\n### 其他\n\n"
            mes, ctrs = print_commits(sorted_commits["other"], "", False)
            ret_message += mes
            for ctr in ctrs:
                if ret_contributor.count(ctr) == 0:
                    ret_contributor.append(ctr)

    else:
        for x in reversed(sorted([x for x in commits.keys()])):
            commit_message = x
            # Contributors 名字转换
            contributor_re = re.search(r"@\[.*\]", x)
            if not contributor_re:
                print(f"Warning: `{x}` has no contributor!")
            else:
                contributor = contributor_re.group()
                if contributor not in contributors:
                    print(f"Warning: New contributor `{contributor}`.")
                else:
                    contributor = contributors[contributor]
                commit_message = re.sub(r"@\[.*\]", "", commit_message)

            mes, ctrs = print_commits(commits[x], indent + "   ", False)
            ret_message += indent + "- " + commit_message

            if ctrs.count(contributor) == 0:
                ret_message += contributor
                if ret_contributor.count(contributor) == 0:
                    ret_contributor.append(contributor)
            for ctr in ctrs:
                ret_message += " " + ctr
                if ret_contributor.count(ctr) == 0:
                    ret_contributor.append(ctr)
            ret_message += "\n" + mes

    return ret_message, ret_contributor

if __name__ == "__main__":
    # 从哪个 tag 开始
    latest = os.popen("git describe --abbrev=0 --tags").read()[:-1]
    nightly = os.popen("git describe --tags").read()[:-1]
    print("From:", latest, ", To:", nightly, "\n")

    # 输出一张好看的 git log 图到控制台
    git_pretty_command = rf'git log {latest}..HEAD --pretty=format:"%C(yellow)%d%Creset %s %C(bold blue)@%an%Creset (%Cgreen%h%Creset)" --graph'
    os.system(git_pretty_command)
    print()

    # 获取详细的 git log 信息
    git_command = rf'git log {latest}..HEAD --pretty=format:"\"%H\":{{\"hash\":\"%h\",\"author\":\"%aN\",\"committer\":\"%cN\",\"message\":\"%s\",\"parent\":\"%P\"}},"'

    with os.popen(git_command) as fp: bf = fp._stream.buffer.read()
    try: gitlogs = bf.decode().strip()
    except: gitlogs = bf.decode("gbk").strip()
    gitlogs = "{" + gitlogs[:-1] + "}"
    raw_commits_info = json.loads(gitlogs)
    for x, y in raw_commits_info.items():
        y["parent"] = y["parent"].split()
    # print(json.dumps(raw_commits_info, ensure_ascii=False, indent=2))

    res = print_commits(build_commits_tree([x for x in raw_commits_info.keys()][0]))

    with open("../changelog.md", "w", encoding="utf8") as f:
        f.write("## " + nightly + "\n" + res[0])