refactor: convert into python package

Signed-off-by: Sefa Eyeoglu <[email protected]>

Author: Scrumplex

.gitignore

@@ -1,3 +1,5 @@
+__pycache__/
+
 .direnv/
 .pre-commit-config.yaml
 

README.md

@@ -0,0 +1,3 @@
+# changelog-generator
+
+tbd

changelog_generator/__init__.py

@@ -0,0 +1 @@
+"""Prism Launcher changelog-generator main package"""

generate2.py renamed to changelog_generator/__main__.py

@@ -1,12 +1,16 @@
 from github import Github
 from github.Label import Label
 from github.PullRequest import PullRequest
+from github.Repository import Repository
+
 from typing import List
 import re
+import os
+import argparse
+
+from .ghutil import find_milestone_by_name, get_prs
+from .util import pr_link, author_link, human_list
 
-REPO = "PrismLauncher/PrismLauncher"
-MILESTONE = "8.0"
-TOKEN = os.environ["GITHUB_TOKEN"]
 
 LABEL_PREFIX = "changelog:"
 MERGED_CATEGORY = "merged"
@@ -20,24 +24,6 @@
 ]
 
 
-def pr_link(pr: PullRequest):
-    return f"[#{pr.number}](https://github.com/{REPO}/pull/{pr.number})"
-
-
-def author_link(author: str):
-    return f"[@{author}](https://github.com/{author})"
-
-
-def human_list(x: List[str]):
-    if len(x) < 1:
-        return "WTF??"
-    elif len(x) == 1:
-        return x[0]
-    y = ", ".join(x[:-1])
-    y += f" and {x[-1]}"
-    return y
-
-
 entries = []
 
 
@@ -46,6 +32,9 @@ def __init__(self, prs: List[PullRequest], category: str):
         self.prs = prs
         self.category = category
 
+    def merge(self, other: Change):
+        this.prs += change.prs
+
     def pr(self):
         return self.prs[0]
 
@@ -87,27 +76,38 @@ def categorize_pr(pr: PullRequest):
     return Change([pr], category)
 
 
-if __name__ == "__main__":
-    output = []
+def merge_child_changes(children: List[Change], parents: List[Change]):
+    for change in merged_changes:
+        m = re.match(PARENT_PATTERN, change.pr().body)
+
+        assert m, f"'{change}' does not define a parent"
+
+        parent_number = int(m.group(1))
 
-    g = Github(TOKEN)
+        found_parent = False
+        for other_change in top_level_changes:
+            if other_change.number() == parent_number:
+                other_change.merge(change)
+                found_parent = True
+                break
+        assert (
+            found_parent
+        ), f"'{change}' parent (#{parent_number}) was not found in this milestone"
 
-    repo = g.get_repo(REPO)
 
-    release_milestone = None
+def generate(repo_name: str, milestone: str, token: str):
+    g = Github(token)
 
-    for milestone in repo.get_milestones():
-        if milestone.title == MILESTONE:
-            release_milestone = milestone
-            break
+    repo = g.get_repo(repo_name)
 
-    issues = repo.get_issues(milestone=release_milestone, state="all")
-    prs = map(
-        lambda issue: issue.as_pull_request(),
-        [*filter(lambda issue: issue.pull_request, issues)],
-    )
-    merged_prs = [*filter(lambda pr: pr.merged, prs)]
-    changes = [*map(categorize_pr, merged_prs)]
+    release_milestone = find_milestone_by_name(repo, milestone)
+
+    assert (
+        release_milestone is not None
+    ), f"Milestone {milestone} not found in repository {repo.url}"
+
+    prs = get_prs(repo, milestone=release_milestone, state="all")
+    changes = [*map(categorize_pr, prs)]
 
     merged_changes = [
         *filter(lambda change: change.category == MERGED_CATEGORY, changes)
@@ -116,24 +116,7 @@ def categorize_pr(pr: PullRequest):
         *filter(lambda change: change.category != MERGED_CATEGORY, changes)
     ]
 
-    for change in merged_changes:
-        m = re.match(PARENT_PATTERN, change.pr().body)
-
-        if m is not None:
-            parent_number = int(m.group(1))
-
-            found_parent = False
-            for other_change in top_level_changes:
-                if other_change.number() == parent_number:
-                    other_change.prs += change.prs
-                    found_parent = True
-                    break
-            if not found_parent:
-                print(
-                    f"'{change}' parent (#{parent_number}) was not found in this milestone"
-                )
-        else:
-            print(f"'{change}' does not define a parent")
+    merge_child_changes(merged_changes, top_level_changes)
 
     final_changes = sorted(top_level_changes, key=lambda x: x.title())
     print("---")
@@ -147,3 +130,19 @@ def categorize_pr(pr: PullRequest):
                 print(change.changelog_entry())
 
         print()
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("repo")
+    parser.add_argument("milestone")
+
+    args = parser.parse_args()
+
+    token = os.environ["GITHUB_TOKEN"]
+
+    generate(args.repo, args.milestone, token)
+
+
+if __name__ == "__main__":
+    main()

changelog_generator/ghutil.py

@@ -0,0 +1,25 @@
+from typing import Generator, List
+
+from github.Milestone import Milestone
+from github.PullRequest import PullRequest
+from github.Repository import Repository
+
+
+def find_milestone_by_name(repo: Repository, milestone_name: str) -> Milestone:
+    for milestone in repo.get_milestones():
+        if milestone.title == milestone_name:
+            return milestone
+    return None
+
+
+def get_prs(
+    repo: Repository, only_merged=True, **kwargs
+) -> Generator[PullRequest, None, None]:
+    issues = repo.get_issues(**kwargs)
+    prs: List[PullRequest] = []
+
+    for issue in issues:
+        if issue.pull_request:
+            pr = issue.as_pull_request()
+            if not only_merged or pr.merged:
+                yield pr

changelog_generator/util.py

@@ -0,0 +1,21 @@
+from typing import Generator, List
+
+from github.PullRequest import PullRequest
+
+
+def pr_link(pr: PullRequest, repo_path: str = "PrismLauncher/PrismLauncher"):
+    return f"[#{pr.number}](https://github.com/{repo_path}/pull/{pr.number})"
+
+
+def author_link(author: str):
+    return f"[@{author}](https://github.com/{author})"
+
+
+def human_list(x: List[str]):
+    if len(x) < 1:
+        return "WTF??"
+    elif len(x) == 1:
+        return x[0]
+    y = ", ".join(x[:-1])
+    y += f" and {x[-1]}"
+    return y

misc/backports.py

@@ -1,8 +1,26 @@
-{...}: {
+{
+  inputs,
+  self,
+  ...
+}: {
   imports = [
     ./dev.nix
+    ./distribution.nix
   ];
 
+  _module.args = {
+    # User-friendly version number.
+    version = builtins.substring 0 8 self.lastModifiedDate;
+  };
+
+  perSystem = {system, ...}: {
+    # Nixpkgs instantiated for supported systems with our overlay.
+    _module.args.pkgs = import inputs.nixpkgs {
+      inherit system;
+      overlays = [self.overlays.default];
+    };
+  };
+
   systems = [
     "x86_64-linux"
     "aarch64-linux"

misc/generate.py

@@ -0,0 +1,31 @@
+{
+  lib,
+  buildPythonApplication,
+  poetry-core,
+  pygithub,
+  # flake
+  self,
+  version,
+}: let
+  inherit (lib.sources) cleanSource;
+in
+  buildPythonApplication {
+    pname = "changelog-generator";
+    inherit version;
+    format = "pyproject";
+
+    src = cleanSource self;
+
+    nativeBuildInputs = [poetry-core];
+
+    propagatedBuildInputs = [pygithub];
+
+    pythonImportsCheck = ["changelog_generator"];
+
+    meta = with lib; {
+      description = "Prism Launcher changelog generator";
+      homepage = "https://github.com/PrismLauncher/changelog-generator";
+      license = licenses.agpl3Only;
+      maintainers = with maintainers; [Scrumplex];
+    };
+  }