cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2025-02-16 19:41:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add type hints to update changelog script

Browse Source
This commit is contained in:
Bruno Alla 2021-11-16 12:54:05 +00:00
parent 96e7503f1f
commit cdc85cf4f6
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
scripts/update_changelog.py
View File

@ -1,8 +1,10 @@
import datetime as dt import datetime as dt
import os import os
from pathlib import Path from pathlib import Path
from typing import Iterable
from github import Github from github import Github
import github.PullRequest
from jinja2 import Template from jinja2 import Template
CURRENT_FILE = Path(__file__) CURRENT_FILE = Path(__file__)
@ -39,7 +41,7 @@ def main() -> None:
file_path.write_text(updated_content) file_path.write_text(updated_content)
def iter_pulls(): def iter_pulls() -> Iterable[github.PullRequest.PullRequest]:
"""Fetch merged pull requests at the date we're interested in.""" """Fetch merged pull requests at the date we're interested in."""
repo = Github(login_or_token=GITHUB_TOKEN).get_repo(GITHUB_REPO) repo = Github(login_or_token=GITHUB_TOKEN).get_repo(GITHUB_REPO)
recent_pulls = repo.get_pulls( recent_pulls = repo.get_pulls(
@ -50,7 +52,9 @@ def iter_pulls():
yield pull yield pull
def group_pulls_by_change_type(pull_requests_list): def group_pulls_by_change_type(
pull_requests_list: list[github.PullRequest.PullRequest],
) -> dict[str, list[github.PullRequest.PullRequest]]:
"""Group pull request by change type.""" """Group pull request by change type."""
grouped_pulls = { grouped_pulls = {
"Changed": [], "Changed": [],
@ -69,7 +73,7 @@ def group_pulls_by_change_type(pull_requests_list):
return grouped_pulls return grouped_pulls
def generate_md(grouped_pulls): def generate_md(grouped_pulls: dict[str, list[github.PullRequest.PullRequest]]) -> str:
"""Generate markdown file from Jinja template.""" """Generate markdown file from Jinja template."""
changelog_template = ROOT / ".github" / "changelog-template.md" changelog_template = ROOT / ".github" / "changelog-template.md"
template = Template(changelog_template.read_text(), autoescape=True) template = Template(changelog_template.read_text(), autoescape=True)