mirror of
https://github.com/ManimCommunity/manim.git
synced 2026-06-22 10:01:47 +00:00
7870407fdc* bump version number * changelog generation, first pass * fixed label mismatches, changelog generation second pass * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * changelog generation, second pass * changelog generation, third pass * changelog generation, final pass * updated i18n files * update readyForTranslation * cut down doc render time Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
325 lines
9.5 KiB
Python
Executable file
325 lines
9.5 KiB
Python
Executable file
#!/usr/bin/env python
|
|
"""Script to generate contributor and pull request lists.
|
|
|
|
This script generates contributor and pull request lists for release
|
|
changelogs using Github v3 protocol. Use requires an authentication token in
|
|
order to have sufficient bandwidth, you can get one following the directions at
|
|
`<https://help.github.com/articles/creating-an-access-token-for-command-line-use/>_
|
|
Don't add any scope, as the default is read access to public information. The
|
|
token may be stored in an environment variable as you only get one chance to
|
|
see it.
|
|
|
|
Usage::
|
|
|
|
$ ./scripts/dev_changelog.py [OPTIONS] TOKEN PRIOR TAG [ADDITIONAL]...
|
|
|
|
The output is utf8 rst.
|
|
|
|
Dependencies
|
|
------------
|
|
|
|
- gitpython
|
|
- pygithub
|
|
|
|
Examples
|
|
--------
|
|
|
|
From a bash command line with $GITHUB environment variable as the GitHub token::
|
|
|
|
$ ./scripts/dev_changelog.py $GITHUB v0.3.0 v0.4.0
|
|
|
|
This would generate 0.4.0-changelog.rst file and place it automatically under
|
|
docs/source/changelog/.
|
|
|
|
As another example, you may also run include PRs that have been excluded by
|
|
providing a space separated list of ticket numbers after TAG::
|
|
|
|
$ ./scripts/dev_changelog.py $GITHUB v0.3.0 v0.4.0 1911 1234 1492 ...
|
|
|
|
|
|
Note
|
|
----
|
|
|
|
This script was taken from Numpy under the terms of BSD-3-Clause license.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import concurrent.futures
|
|
import datetime
|
|
import os
|
|
import re
|
|
from collections import defaultdict
|
|
from pathlib import Path
|
|
from textwrap import dedent, indent
|
|
|
|
import click
|
|
import cloup
|
|
from git import Repo
|
|
from github import Github
|
|
from tqdm import tqdm
|
|
|
|
from manim.constants import CONTEXT_SETTINGS, EPILOG
|
|
|
|
this_repo = Repo(str(Path(__file__).resolve().parent.parent))
|
|
|
|
PR_LABELS = {
|
|
"breaking changes": "Breaking changes",
|
|
"highlight": "Highlights",
|
|
"pr:deprecation": "Deprecated classes and functions",
|
|
"new feature": "New features",
|
|
"enhancement": "Enhancements",
|
|
"pr:bugfix": "Fixed bugs",
|
|
"documentation": "Documentation-related changes",
|
|
"testing": "Changes concerning the testing system",
|
|
"infrastructure": "Changes to our development infrastructure",
|
|
"maintenance": "Code quality improvements and similar refactors",
|
|
"revert": "Changes that needed to be reverted again",
|
|
"release": "New releases",
|
|
"unlabeled": "Unclassified changes",
|
|
}
|
|
|
|
SILENT_CONTRIBUTORS = [
|
|
"dependabot[bot]",
|
|
]
|
|
|
|
|
|
def update_citation(version, date):
|
|
current_directory = os.path.dirname(__file__)
|
|
parent_directory = os.path.split(current_directory)[0]
|
|
with open(os.path.join(current_directory, "TEMPLATE.cff")) as a, open(
|
|
os.path.join(parent_directory, "CITATION.cff"),
|
|
"w",
|
|
newline="\n",
|
|
) as b:
|
|
contents = a.read()
|
|
contents = contents.replace("<version>", version)
|
|
contents = contents.replace("<date_released>", date)
|
|
b.write(contents)
|
|
|
|
|
|
def process_pullrequests(lst, cur, github_repo, pr_nums):
|
|
lst_commit = github_repo.get_commit(sha=this_repo.git.rev_list("-1", lst))
|
|
lst_date = lst_commit.commit.author.date
|
|
|
|
authors = set()
|
|
reviewers = set()
|
|
pr_by_labels = defaultdict(list)
|
|
with concurrent.futures.ThreadPoolExecutor() as executor:
|
|
future_to_num = {
|
|
executor.submit(github_repo.get_pull, num): num for num in pr_nums
|
|
}
|
|
for future in tqdm(
|
|
concurrent.futures.as_completed(future_to_num), "Processing PRs"
|
|
):
|
|
pr = future.result()
|
|
authors.add(pr.user)
|
|
reviewers = reviewers.union(rev.user for rev in pr.get_reviews())
|
|
pr_labels = [label.name for label in pr.labels]
|
|
for label in PR_LABELS.keys():
|
|
if label in pr_labels:
|
|
pr_by_labels[label].append(pr)
|
|
break # ensure that PR is only added in one category
|
|
else:
|
|
pr_by_labels["unlabeled"].append(pr)
|
|
|
|
# identify first-time contributors:
|
|
author_names = []
|
|
for author in authors:
|
|
name = author.name if author.name is not None else author.login
|
|
if name in SILENT_CONTRIBUTORS:
|
|
continue
|
|
if github_repo.get_commits(author=author, until=lst_date).totalCount == 0:
|
|
name += " +"
|
|
author_names.append(name)
|
|
|
|
reviewer_names = []
|
|
for reviewer in reviewers:
|
|
name = reviewer.name if reviewer.name is not None else reviewer.login
|
|
if name in SILENT_CONTRIBUTORS:
|
|
continue
|
|
reviewer_names.append(name)
|
|
|
|
# Sort items in pr_by_labels
|
|
for i in pr_by_labels:
|
|
pr_by_labels[i] = sorted(pr_by_labels[i], key=lambda pr: pr.number)
|
|
|
|
return {
|
|
"authors": sorted(author_names),
|
|
"reviewers": sorted(reviewer_names),
|
|
"PRs": pr_by_labels,
|
|
}
|
|
|
|
|
|
def get_pr_nums(lst, cur):
|
|
print("Getting PR Numbers:")
|
|
prnums = []
|
|
|
|
# From regular merges
|
|
merges = this_repo.git.log("--oneline", "--merges", f"{lst}..{cur}")
|
|
issues = re.findall(r".*\(\#(\d+)\)", merges)
|
|
prnums.extend(int(s) for s in issues)
|
|
|
|
# From fast forward squash-merges
|
|
commits = this_repo.git.log(
|
|
"--oneline",
|
|
"--no-merges",
|
|
"--first-parent",
|
|
f"{lst}..{cur}",
|
|
)
|
|
split_commits = list(
|
|
filter(
|
|
lambda x: not any(
|
|
["pre-commit autoupdate" in x, "New Crowdin updates" in x]
|
|
),
|
|
commits.split("\n"),
|
|
),
|
|
)
|
|
commits = "\n".join(split_commits)
|
|
issues = re.findall(r"^.*\(\#(\d+)\)$", commits, re.M)
|
|
prnums.extend(int(s) for s in issues)
|
|
|
|
print(prnums)
|
|
return prnums
|
|
|
|
|
|
def get_summary(body):
|
|
pattern = '<!--changelog-start-->([^"]*)<!--changelog-end-->'
|
|
try:
|
|
has_changelog_pattern = re.search(pattern, body)
|
|
if has_changelog_pattern:
|
|
|
|
return has_changelog_pattern.group()[22:-21].strip()
|
|
except Exception:
|
|
print(f"Error parsing body for changelog: {body}")
|
|
|
|
|
|
@cloup.command(
|
|
context_settings=CONTEXT_SETTINGS,
|
|
epilog=EPILOG,
|
|
)
|
|
@click.argument("token")
|
|
@click.argument("prior")
|
|
@click.argument("tag")
|
|
@click.argument(
|
|
"additional",
|
|
nargs=-1,
|
|
required=False,
|
|
type=int,
|
|
)
|
|
@click.option(
|
|
"-o",
|
|
"--outfile",
|
|
type=str,
|
|
help="Path and file name of the changelog output.",
|
|
)
|
|
def main(token, prior, tag, additional, outfile):
|
|
"""Generate Changelog/List of contributors/PRs for release.
|
|
|
|
TOKEN is your GitHub Personal Access Token.
|
|
|
|
PRIOR is the tag/commit SHA of the previous release.
|
|
|
|
TAG is the tag of the new release.
|
|
|
|
ADDITIONAL includes additional PR(s) that have not been recognized automatically.
|
|
"""
|
|
|
|
lst_release, cur_release = prior, tag
|
|
|
|
github = Github(token)
|
|
github_repo = github.get_repo("ManimCommunity/manim")
|
|
|
|
pr_nums = get_pr_nums(lst_release, cur_release)
|
|
if additional:
|
|
print(f"Adding {additional} to the mix!")
|
|
pr_nums = pr_nums + list(additional)
|
|
|
|
# document authors
|
|
contributions = process_pullrequests(lst_release, cur_release, github_repo, pr_nums)
|
|
authors = contributions["authors"]
|
|
reviewers = contributions["reviewers"]
|
|
|
|
# update citation file
|
|
today = datetime.date.today()
|
|
update_citation(tag, str(today))
|
|
|
|
if not outfile:
|
|
outfile = (
|
|
Path(__file__).resolve().parent.parent / "docs" / "source" / "changelog"
|
|
)
|
|
outfile = outfile / f"{tag[1:] if tag.startswith('v') else tag}-changelog.rst"
|
|
else:
|
|
outfile = Path(outfile).resolve()
|
|
|
|
with outfile.open("w", encoding="utf8", newline="\n") as f:
|
|
f.write("*" * len(tag) + "\n")
|
|
f.write(f"{tag}\n")
|
|
f.write("*" * len(tag) + "\n\n")
|
|
|
|
f.write(f":Date: {today.strftime('%B %d, %Y')}\n\n")
|
|
|
|
heading = "Contributors"
|
|
f.write(f"{heading}\n")
|
|
f.write("=" * len(heading) + "\n\n")
|
|
f.write(
|
|
dedent(
|
|
f"""\
|
|
A total of {len(set(authors).union(set(reviewers)))} people contributed to this
|
|
release. People with a '+' by their names authored a patch for the first
|
|
time.\n
|
|
""",
|
|
),
|
|
)
|
|
|
|
for author in authors:
|
|
f.write(f"* {author}\n")
|
|
|
|
f.write("\n")
|
|
f.write(
|
|
dedent(
|
|
"""
|
|
The patches included in this release have been reviewed by
|
|
the following contributors.\n
|
|
""",
|
|
),
|
|
)
|
|
|
|
for reviewer in reviewers:
|
|
f.write(f"* {reviewer}\n")
|
|
|
|
# document pull requests
|
|
heading = "Pull requests merged"
|
|
f.write("\n")
|
|
f.write(heading + "\n")
|
|
f.write("=" * len(heading) + "\n\n")
|
|
f.write(
|
|
f"A total of {len(pr_nums)} pull requests were merged for this release.\n\n",
|
|
)
|
|
|
|
pr_by_labels = contributions["PRs"]
|
|
for label in PR_LABELS.keys():
|
|
pr_of_label = pr_by_labels[label]
|
|
|
|
if pr_of_label:
|
|
heading = PR_LABELS[label]
|
|
f.write(f"{heading}\n")
|
|
f.write("-" * len(heading) + "\n\n")
|
|
|
|
for PR in pr_by_labels[label]:
|
|
num = PR.number
|
|
url = PR.html_url
|
|
title = PR.title
|
|
label = PR.labels
|
|
f.write(f"* :pr:`{num}`: {title}\n")
|
|
overview = get_summary(PR.body)
|
|
if overview:
|
|
f.write(indent(f"{overview}\n\n", " "))
|
|
else:
|
|
f.write("\n\n")
|
|
|
|
print(f"Wrote changelog to: {outfile}")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|