add a bootstrap function for all changelog entries

Author: blink1073

github_activity/cli.py

@@ -7,6 +7,7 @@
 from .git import _git_installed_check
 from .github_activity import _parse_target
 from .github_activity import generate_activity_md
+from .github_activity import generate_all_activity_md
 
 DESCRIPTION = "Generate a markdown changelog of GitHub activity within a date window."
 parser = argparse.ArgumentParser(description=DESCRIPTION)
@@ -109,6 +110,12 @@
     default=None,
     help=("""The branch or reference name to filter pull requests by"""),
 )
+parser.add_argument(
+    "--all",
+    default=False,
+    action="store_true",
+    help=("""Whether to include all the GitHub tags"""),
+)
 
 
 def main():
@@ -151,19 +158,28 @@ def main():
         except Exception:
             raise ValueError(err)
 
-    md = generate_activity_md(
-        args.target,
-        since=args.since,
-        until=args.until,
+    common_kwargs = dict(
         kind=args.kind,
         auth=args.auth,
         tags=tags,
         include_issues=bool(args.include_issues),
         include_opened=bool(args.include_opened),
         strip_brackets=bool(args.strip_brackets),
-        heading_level=args.heading_level,
         branch=args.branch,
     )
+
+    if args.all:
+        md = generate_all_activity_md(args.target, **common_kwargs)
+
+    else:
+        md = generate_activity_md(
+            args.target,
+            since=args.since,
+            until=args.until,
+            heading_level=args.heading_level,
+            **common_kwargs
+        )
+
     if not md:
         return
 

github_activity/github_activity.py

@@ -4,6 +4,10 @@
 import sys
 import urllib
 from pathlib import Path
+import re
+import shlex
+import subprocess
+from tempfile import TemporaryDirectory
 from subprocess import PIPE
 from subprocess import run
 
@@ -153,6 +157,112 @@ def get_activity(
     return query_data
 
 
+def generate_all_activity_md(
+    target,
+    pattern=r'(v?\d+\.\d+\.\d+)$',
+    kind=None,
+    auth=None,
+    tags=None,
+    include_issues=False,
+    include_opened=False,
+    strip_brackets=False,
+    branch=None,
+):
+    """Generate a full markdown changelog of GitHub activity of a repo based on release tags.
+
+    Parameters
+    ----------
+    target : string
+        The GitHub organization/repo for which you want to grab recent issues/PRs.
+        Can either be *just* and organization (e.g., `jupyter`) or a combination
+        organization and repo (e.g., `jupyter/notebook`). If the former, all
+        repositories for that org will be used. If the latter, only the specified
+        repository will be used. Can also be a URL to a GitHub org or repo.
+    pattern: str
+        The expression used to match a release tag
+    kind : ["issue", "pr"] | None
+        Return only issues or PRs. If None, both will be returned.
+    auth : string | None
+        An authentication token for GitHub. If None, then the environment
+        variable `GITHUB_ACCESS_TOKEN` will be tried.
+    tags : list of strings | None
+        A list of the tags to use in generating subsets of PRs for the markdown report.
+        Must be one of:
+
+            ['enhancement', 'bugs', 'maintenance', 'documentation', 'api_change']
+
+        If None, all of the above tags will be used.
+    include_issues : bool
+        Include Issues in the markdown output. Default is False.
+    include_opened : bool
+        Include a list of opened items in the markdown output. Default is False.
+    strip_brackets : bool
+        If True, strip any text between brackets at the beginning of the issue/PR title.
+        E.g., [MRG], [DOC], etc.
+    branch : string | None
+        The branch or reference name to filter pull requests by
+
+    Returns
+    -------
+    entry: str
+        The markdown changelog entry for all of the release tags in the repo.
+    """
+    with TemporaryDirectory() as td:
+
+        subprocess.run(shlex.split(f'git clone git@github.com:{target}.git repo'), cwd=td)
+        repo = os.path.join(td, 'repo')
+        subprocess.run(shlex.split('git fetch upstream --tags'), cwd=repo)
+
+        cmd = 'git log --tags --simplify-by-decoration --pretty="format:%h | %D"'
+        data = subprocess.check_output(shlex.split(cmd), cwd=repo).decode('utf-8').splitlines()
+
+    pattern = f'tag: {pattern}'
+
+    def filter(datum):
+        _, tag = datum
+        return re.match(pattern, tag) is not None
+
+    data = [d.split(' | ') for (i, d) in enumerate(data)]
+    data = [d for d in data if filter(d)]
+    output = ""
+
+    for i in range(len(data) - 1):
+        curr_data = data[i]
+        prev_data = data[i + 1]
+
+        since = prev_data[0]
+        until = curr_data[0]
+
+        match = re.search(pattern, curr_data[1])
+        tag = match.groups()[0]
+
+        print(f'\n({i + 1}/{len(data)})', since, until, tag, file=sys.stderr)
+        md = generate_activity_md(
+                target,
+                since=since,
+                heading_level=2,
+                until=until,
+                auth=auth,
+                kind=kind,
+                include_issues=include_issues,
+                include_opened=include_opened,
+                strip_brackets=strip_brackets,
+                branch=branch
+            )
+
+        if not md:
+            continue
+
+        # Replace the header line with our version tag
+        md = '\n'.join(md.splitlines()[1:])
+
+        output += f"""
+## {tag}
+{md}
+"""
+    return output
+
+
 def generate_activity_md(
     target,
     since=None,
@@ -212,9 +322,8 @@ def generate_activity_md(
 
     Returns
     -------
-    query_data : pandas DataFrame
-        A munged collection of data returned from your query. This
-        will be a combination of issues and PRs.
+    entry: str
+        The markdown changelog entry
     """
     org, repo = _parse_target(target)
 
@@ -574,3 +683,4 @@ def _get_latest_tag():
     out = run("git describe --tags".split(), stdout=PIPE)
     tag = out.stdout.decode().rsplit("-", 2)[0]
     return tag
+