chore: upgrade release scripts

Author: Tigge

CHANGELOG.md

@@ -1,11 +1,10 @@
 #!/usr/bin/env python3
 
 import argparse
-import re
-import subprocess
 import sys
 
 import utils
+import config
 
 #
 # Stop immediately if version too old.
@@ -16,17 +15,10 @@
         f"You need Python >= {_MINIMUM_PYTHON_VERSION}, but you are running {sys.version}"
     )
 
-GITHUB_COMPARE_URL = (
-    "https://github.com/AxisCommunications/practical-react-components/compare"
-)
-GITHUB_COMMIT_URL = (
-    "https://github.com/AxisCommunications/practical-react-components/commit"
-)
-
 GROUP_TITLES = {
     "build": "👷 Build",
     "chore": "🚧 Maintenance",
-    "ci": "🚦 Continous integration",
+    "ci": "🚦 Continuous integration",
     "docs": "📝 Documentation",
     "feat": "✨ Features",
     "fix": "🐛 Bug fixes",
@@ -41,36 +33,45 @@
 def changelog_part(commitish_to: str, commitish_from: str, version: str):
     date = utils.cmd(["git", "log", "-1", "--format=%ci", commitish_to])
 
-    commit_range = (
-        f"{commitish_from}..HEAD"
-        if commitish_to == "HEAD"
-        else f"{commitish_from}..{commitish_to}~"
-    )
+    if commitish_from is None:
+        commit_range = commitish_to
+    elif commitish_to == "HEAD":
+        commit_range = f"{commitish_from}..HEAD"
+    else:
+        commit_range = f"{commitish_from}..{commitish_to}~"
 
     commits = utils.cmd(
-        ["git", "log", "--no-merges", "--date-order", "--format=%H%x09%s", commit_range]
+        [
+            "git",
+            "log",
+            "--no-merges",
+            "--date-order",
+            "--format=%H%n%h%n%B%x1f",
+            commit_range,
+        ]
     )
 
     if commits == "":
         return ""
 
     messages = {}
 
-    for commit in commits.split("\n"):
-        sha, msg = commit.split(maxsplit=1)
-        shortsha = utils.cmd(["git", "log", "-1", "--format=%h", sha])
+    for commit in commits.split("\x1f"):
+        sha, shortsha, msg = commit.strip().split("\n", maxsplit=2)
 
         try:
             data = utils.conventional_commit_parse(msg)
+            issues = utils.closing_issues_commit_parse(msg)
             messages.setdefault(data["type"], []).append(
-                {**data, "sha": sha, "shortsha": shortsha}
+                {**data, "issues": issues, "sha": sha, "shortsha": shortsha}
             )
         except:
             # No conventional commit
             pass
 
     content = [
-        f"## [{version}]({GITHUB_COMPARE_URL}/{commitish_from}...{version}) ({date})"
+        f"## [{version}]({config.GITHUB_RELEASE_URL}/{version})",
+        f"{date}, [Compare changes]({config.GITHUB_COMPARE_URL}/{commitish_from}...{version})",
     ]
 
     for group in GROUP_TITLES.keys():
@@ -81,10 +82,24 @@ def changelog_part(commitish_to: str, commitish_from: str, version: str):
 
         for data in messages[group]:
 
-            prefix = (
-                f'  - **{data["scope"]}**: ' if data["scope"] is not None else "  - "
+            prefix = "  - "
+
+            pull_request = utils.get_github_pull_request(data["sha"])
+            # pull_request[0] is id, pull_request[1] is url
+            if pull_request is not None:
+                prefix += f"[!{pull_request[0]}]({pull_request[1]}) - "
+
+            if data["scope"] is not None:
+                prefix += f'**{data["scope"]}**: '
+
+            postfix = (
+                f' ([`{data["shortsha"]}`]({config.GITHUB_COMMIT_URL}/{data["sha"]}))'
             )
-            postfix = f' ([{data["shortsha"]}]({GITHUB_COMMIT_URL}/{data["sha"]}))'
+
+            commit_author = utils.get_github_author(data["sha"])
+            # commit_author[0] is username, commit_author[1] is url
+            if commit_author is not None:
+                postfix += f" ([**@{commit_author[0]}**]({commit_author[1]}))"
 
             if data["breaking"]:
                 content.append(f'{prefix}**BREAKING** {data["description"]}{postfix}')
@@ -96,7 +111,6 @@ def changelog_part(commitish_to: str, commitish_from: str, version: str):
 
 HEADER = """
 # Changelog
-
 All notable changes to this project will be documented in this file.
 
 """
@@ -114,6 +128,14 @@ def changelog_part(commitish_to: str, commitish_from: str, version: str):
         help="Don't include a changelog header",
     )
 
+    parser.add_argument(
+        "-r",
+        "--release",
+        type=str,
+        metavar="RELEASE",
+        help="New release tag (e.g. vX.Y.Z), includes full changelog with a new entry for things not tagged",
+    )
+
     subparsers = parser.add_subparsers(
         dest="type", metavar="COMMAND", help='One of "single" or "full".', required=True
     )
@@ -126,13 +148,6 @@ def changelog_part(commitish_to: str, commitish_from: str, version: str):
     full = subparsers.add_parser(
         "full", description="Generate a changelog covering entire history."
     )
-    full.add_argument(
-        "-r",
-        "--release",
-        type=str,
-        metavar="RELEASE",
-        help="New release tag (e.g. vX.Y.Z), includes full changelog with a new entry for things not tagged",
-    )
 
     args = parser.parse_args()
 
@@ -149,6 +164,10 @@ def changelog_part(commitish_to: str, commitish_from: str, version: str):
         ]
     ).split()
 
+    if args.release is not None:
+        tags.insert(0, "HEAD")
+    tags.append(None)
+
     if args.type == "single":
         if args.tag is None:
             try:
@@ -160,23 +179,19 @@ def changelog_part(commitish_to: str, commitish_from: str, version: str):
             print(f"Error: tag {args.tag} not found!")
             sys.exit(1)
 
-    if args.type == "full" and args.release is not None:
-        tags.insert(0, "HEAD")
-
-    content = [HEADER] if not args.skip_header else []
+    if not args.skip_header:
+        sys.stdout.write(HEADER)
 
     for commitish_to, commitish_from in zip(tags[:-1], tags[1:]):
         if args.type == "single" and args.tag != commitish_to:
             continue
-
-        content.append(
+        sys.stdout.write(
             changelog_part(
                 commitish_to,
                 commitish_from,
                 args.release if commitish_to == "HEAD" else commitish_to,
             )
         )
-        content.append("")
+        sys.stdout.write("\n\n")
 
-    sys.stdout.write("\n".join(content))
     sys.stdout.close()

sbin/changelog.py

@@ -1,8 +1,7 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 import argparse
 import sys
-import subprocess
 
 import utils
 
@@ -11,11 +10,9 @@
     description="""
 If no range is given, HEAD~..HEAD is used (so only the latest commit
 will be checked).
-
 Note that the a range fa56eb..HEAD does not include the fa56eb commit
 (to start from e.g. fa56eb, you would write fa56eb~..HEAD to use the parent
 as starting point).
-
 Check if message conforms to a conventional commit message, see
 https://www.conventionalcommits.org/en/v1.0.0/#specification
 """

sbin/commitlint.py

@@ -0,0 +1,7 @@
+GITHUB_URL = "https://github.com"
+GITHUB_API_URL = "https://api.github.com"
+GITHUB_REPOSITORY = "AxisCommunications/practical-react-components"
+
+GITHUB_COMPARE_URL = f"{GITHUB_URL}/{GITHUB_REPOSITORY}/compare"
+GITHUB_COMMIT_URL = f"{GITHUB_URL}/{GITHUB_REPOSITORY}/commit"
+GITHUB_RELEASE_URL = f"{GITHUB_URL}/{GITHUB_REPOSITORY}/releases/tag"

sbin/config.py

@@ -4,6 +4,7 @@
 import json
 
 import utils
+import changelog
 
 parser = argparse.ArgumentParser()
 parser.add_argument(
@@ -34,7 +35,7 @@
             "--increment",
             args.level,
             "--preid",
-            "alpha",
+            "beta",
         ]
     )
     next_tag = f"v{next_version}"
@@ -45,11 +46,17 @@
     utils.cmd(["yarn", "version", "apply", "--all"])
 
     print(" - Update changelog")
-    changelog = utils.cmd(["./sbin/changelog.py", "full", "--release", next_tag])
-    with open("CHANGELOG.md", "w") as f:
-        f.write(changelog)
+    changelog_part = utils.cmd(
+        ["./sbin/changelog.py", "--release", next_tag, "--skip-header", "single"]
+    )
+    with open("CHANGELOG.md", "r+") as f:
+        old = f.read()
+        f.seek(0)
+        f.write(changelog.HEADER)
+        f.write(changelog_part)
+        f.write("\n\n")
+        f.write(old[len(changelog.HEADER) :])
 
     print(" - Create release commit and tag")
-    utils.cmd(["git", "add", "-u"])
-    utils.cmd(["git", "commit", "-m", next_tag])
+    utils.cmd(["git", "commit", "-a", "-m", next_tag])
     utils.cmd(["git", "tag", "-a", "-m", next_tag, next_tag])

sbin/release.py

@@ -1,8 +1,13 @@
+import os
+import urllib.request
+import json
 import re
 import subprocess
 import sys
 import typing
 
+import config
+
 possible_types = [
     "build",
     "chore",
@@ -19,14 +24,16 @@
 
 types = "|".join(possible_types)
 
-re_conventional_commit_header = re.compile(fr"^({types})(?:\(([^\)]+)\))?(!?): (.*)$")
+re_conventional_commit_header = re.compile(
+    rf"^({types})(?:\(([^\)]+)\))?(!?): (.*)(?:\n|$)"
+)
 
 
 def conventional_commit_parse(message: str):
-    match = re.fullmatch(re_conventional_commit_header, message)
+    match = re.match(re_conventional_commit_header, message)
 
     if match is None:
-        raise Exception()
+        raise Exception("Not a conventional commit")
 
     type, scope, breaking, header = match.groups()
 
@@ -38,6 +45,52 @@ def conventional_commit_parse(message: str):
     }
 
 
+re_closing_issues = re.compile(
+    r"^Closes: ([A-Z]+-[0-9]+)$", re.MULTILINE | re.IGNORECASE
+)
+
+
+def closing_issues_commit_parse(message: str):
+    return re.findall(re_closing_issues, message)
+
+
+def get_github_api(url: str):
+    try:
+        token = os.environ["GITHUB_TOKEN"]
+        req = urllib.request.Request(
+            f"{config.GITHUB_API_URL}{url}",
+            headers={"Authorization": f"Bearer {token}"},
+        )
+        res = urllib.request.urlopen(req)
+        data = json.load(res)
+
+        return data
+    except KeyError as e:
+        print("GITHUB_TOKEN environment not set")
+        sys.exit(1)
+    except urllib.error.HTTPError as e:
+        print("GitHub API request failed:", e)
+        sys.exit(1)
+
+
+def get_github_pull_request(sha: str):
+    data = get_github_api(f"/repos/{config.GITHUB_REPOSITORY}/commits/{sha}/pulls")
+
+    if data is None or len(data) == 0:
+        return None
+
+    return (data[0]["number"], data[0]["html_url"])
+
+
+def get_github_author(sha: str):
+    data = get_github_api(f"/repos/{config.GITHUB_REPOSITORY}/commits/{sha}")
+
+    if data is None or data["author"] is None:
+        return None
+
+    return (data["author"]["login"], data["author"]["html_url"])
+
+
 def cmd(cmd: typing.List[str]) -> str:
     """Call shell command and return the result"""
     try: