107 lines
3.8 KiB
Python
107 lines
3.8 KiB
Python
import os
|
|
import re
|
|
from argparse import ArgumentParser
|
|
from collections import defaultdict
|
|
|
|
import github # pip install PyGithub
|
|
# ensure the milestone is open before run this
|
|
docmap = {
|
|
"Feature": "Feature",
|
|
"Enhancement": "Enhancement",
|
|
"Bug": "Bugfix",
|
|
"Document": "Document",
|
|
"Refactor": "Refactor",
|
|
"Abolishment": "Abolishment",
|
|
"Development": "Development",
|
|
}
|
|
|
|
|
|
def generate_msg_from_repo(repo_name, tag_name, lastestRelease):
|
|
"""Generate changelog messages from repository and tag name.
|
|
|
|
Envs:
|
|
GITHUB_HOST: the custom github host.
|
|
GITHUB_TOKEN: the github access token.
|
|
|
|
Args:
|
|
repo_name (str): The repository name
|
|
tag_name (str): the tag name
|
|
"""
|
|
hostname = os.getenv("GITHUB_HOST") or "api.github.com"
|
|
token = os.getenv("GITHUB_TOKEN")
|
|
desc_mapping = defaultdict(list)
|
|
|
|
gh = github.Github(token, base_url=f"https://{hostname}")
|
|
repo = gh.get_repo(repo_name)
|
|
milestone = find_milestone(repo, tag_name, lastestRelease)
|
|
|
|
for issue in repo.get_issues(state="closed", milestone=milestone): # type: ignore
|
|
# REF https://pygithub.readthedocs.io/en/latest/github_objects/Issue.html#github.Issue.Issue
|
|
desc_mapping[get_issue_first_label(issue)].append(
|
|
{"title": issue.title, "url": issue.html_url}
|
|
)
|
|
generate_msg(desc_mapping)
|
|
|
|
|
|
def find_milestone(repo, title, lastestRelease):
|
|
"""Find the milestone in a repository that is similar to milestone title
|
|
|
|
Args:
|
|
repo (github.repository.Repository): The repository to search
|
|
title (str): the title to match
|
|
|
|
Returns:
|
|
The milestone which title matches the given argument.
|
|
If no milestone matches, it will return None
|
|
"""
|
|
pat = re.search("v([0-9.]+)", title)
|
|
thisRelease = title.split("/")[-1]
|
|
if not pat:
|
|
return None
|
|
version = pat.group(1)
|
|
print(f'''
|
|
<p>
|
|
<a href="https://github.com/siyuan-note/siyuan/actions/workflows/cd.yml"><img src="https://img.shields.io/github/actions/workflow/status/siyuan-note/siyuan/cd.yml?event=push&label=cd.yml%20Action&logo=github" style="cursor:pointer;height: 30px;margin: 3px auto;"/></a>
|
|
<a href="https://github.com/siyuan-note/siyuan/releases/{thisRelease}/"><img src="https://img.shields.io/github/downloads/siyuan-note/siyuan/{thisRelease}/total?logo=github" style="cursor:pointer;height: 30px;margin: 3px auto;"/></a>
|
|
<img alt="GitHub commits difference between two branches/tags/commits" src="https://img.shields.io/github/commits-difference/siyuan-note/siyuan?base={lastestRelease}&head={thisRelease}&logo=git" style="cursor:pointer;height: 30px;margin: 3px auto;"/>
|
|
</p>
|
|
|
|
''')
|
|
for milestone in repo.get_milestones():
|
|
if version in milestone.title:
|
|
return milestone
|
|
|
|
|
|
def get_issue_first_label(issue):
|
|
"""Get the first label from issue, if no labels, return empty string."""
|
|
for label in issue.get_labels():
|
|
if label.name in docmap:
|
|
return label.name
|
|
return ""
|
|
|
|
|
|
def generate_msg(desc_mapping):
|
|
"""Print changelogs from direction."""
|
|
print()
|
|
for header in docmap:
|
|
if not desc_mapping[header]:
|
|
continue
|
|
print(f"### {docmap[header]}\n")
|
|
for item in desc_mapping[header]:
|
|
print(f"* [{item['title']}]({item['url']})")
|
|
print()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
parser = ArgumentParser(
|
|
description="Automaticly generate information from issues by tag."
|
|
)
|
|
parser.add_argument("-t", "--tag", help="the tag to filter issues.")
|
|
parser.add_argument("-b", "--lastestRelease", help="lastest Release")
|
|
parser.add_argument("repo", help="The repository name")
|
|
args = parser.parse_args()
|
|
|
|
try:
|
|
generate_msg_from_repo(args.repo, args.tag, args.lastestRelease)
|
|
except AssertionError:
|
|
print(args.tag)
|