chore: refactor changelog, commitlint and release script

Rewrite the scripts in python and improve the changelog script to be
able to generate changelogs for single tags. This feature is used in the
release workflow on GitHub to generate a release changelog.

Author: Tigge

.github/workflows/publish.yml

@@ -28,6 +28,9 @@ jobs:
       - name: Build
         run: yarn build:libs
 
+      - name: Release changelog
+        run: ./sbin/changelog.py --skip-header single --tag ${{ github.ref }} > release-CHANGELOG.md
+
       - name: Release
         id: release
         uses: actions/create-release@v1
@@ -36,6 +39,7 @@ jobs:
         with:
           tag_name: ${{ github.ref }}
           release_name: Release ${{ github.ref }}
+          body_path: release-CHANGELOG.md
           draft: false
           prerelease: false
 

.gitignore

@@ -16,3 +16,5 @@ yarn-error.log*
 !.yarn/versions
 
 .DS_Store
+
+.env

package.json

@@ -24,12 +24,12 @@
     "lint:fix": "yarn lint:ts --fix && yarn reformat",
     "lint:ts": "eslint --ext \".ts,.tsx\" . --cache",
     "lint:css": "stylelint \"./**/*.tsx\"",
-    "commitlint": "sbin/commitlint.sh",
+    "commitlint": "sbin/commitlint.py",
     "prettier:check": "prettier --check '{packages/*/src/**/*.{js,ts,jsx,tsx},cypress/**/*.{js,ts,jsx,tsx,json}}'",
     "test": "jest",
     "build": "yarn workspaces foreach --topological run build",
     "prettier:fix": "prettier --write '{packages/*/src/**/*.{js,ts,jsx,tsx},cypress/**/*.{js,ts,jsx,tsx,json}}'",
-    "release": "yarn && yarn lint && yarn test && yarn build && sbin/release.sh",
+    "release": "yarn && yarn lint && yarn test && yarn build && sbin/release.py",
     "dev": "yarn workspaces foreach -i --parallel --exclude practical-react-components-ui-tests run dev",
     "cypress:ui-tests": "yarn workspace practical-react-components-ui-tests dev",
     "cypress:chrome": "yarn workspace practical-react-components-ui-tests wait-on http-get://localhost:9009 -i 2000 -d 5000 && yarn workspace practical-react-components-ui-tests cypress run --browser chrome --headless",

sbin/changelog.py

@@ -0,0 +1,149 @@
+#!/usr/bin/env python
+
+import argparse
+import re
+import subprocess
+import sys
+
+import utils
+
+GITHUB_COMPARE_URL = (
+    "https://github.com/AxisCommunications/practical-react-components/compare"
+)
+GITHUB_COMMIT_URL = (
+    "https://github.com/AxisCommunications/practical-react-components/commit"
+)
+
+GROUP_TITLES = {
+    "feat": "🚀 Features",
+    "fix": "🐛 Bug fixes",
+    "refactor": "🧰 Refactoring",
+    "docs": "📝 Documentation",
+    "chore": "🚧 Maintenance",
+    "ci": "🚦 Continous integration",
+}
+
+
+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}~"
+    )
+
+    commits = utils.cmd(
+        ["git", "log", "--no-merges", "--date-order", "--format=%H%x09%s", commit_range]
+    )
+
+    messages = {}
+
+    for commit in commits.split("\n"):
+        sha, msg = commit.split(maxsplit=1)
+        shortsha = utils.cmd(["git", "log", "-1", "--format=%h", sha])
+
+        try:
+            data = utils.conventional_commit_parse(msg)
+            messages.setdefault(data["type"], []).append(
+                {**data, "sha": sha, "shortsha": shortsha}
+            )
+        except:
+            # No conventional commit
+            pass
+
+    content = [
+        f"## [{version}]({GITHUB_COMPARE_URL}/{commitish_from}...{version}) ({date})"
+    ]
+
+    for group in GROUP_TITLES.keys():
+        if group not in messages:
+            continue
+
+        content.append(f"\n### {GROUP_TITLES[group]}\n")
+
+        for data in messages[group]:
+
+            prefix = (
+                f'  - **{data["scope"]}**: ' if data["scope"] is not None else "  - "
+            )
+            postfix = f' ([{data["shortsha"]}]({GITHUB_COMMIT_URL}/{data["sha"]}))'
+
+            if data["breaking"]:
+                content.append(f'{prefix}**BREAKING** {data["description"]}{postfix}')
+            else:
+                content.append(f'{prefix} {data["description"]}{postfix}')
+
+    return "\n".join(content)
+
+
+HEADER = """
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+"""
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description="Generate or update a CHANGELOG.md file."
+    )
+
+    parser.add_argument(
+        "-s",
+        "--skip-header",
+        action="store_true",
+        help="Don't include a changelog header",
+    )
+
+    subparsers = parser.add_subparsers(dest="type")
+
+    single = subparsers.add_parser(
+        "single", description="Changelog for a single release"
+    )
+    single.add_argument("-tag", "--tag", type=str, metavar="TAG")
+
+    full = subparsers.add_parser("full")
+    full.add_argument(
+        "-release",
+        "--release",
+        type=str,
+        metavar="RELEASE",
+        help="New relase, includes full changelog with a new entry for things not tagged",
+    )
+
+    args = parser.parse_args()
+
+    tags = utils.cmd(
+        [
+            "git",
+            "-c",
+            "versionsort.suffix=-alpha",
+            "tag",
+            "--list",
+            "--sort=-version:refname",
+            "--merged",
+            "HEAD",
+        ]
+    ).split()
+    if args.type == "full" and args.release is not None:
+        tags.insert(0, "HEAD")
+
+    content = [HEADER] if not args.skip_header else []
+
+    for commitish_to, commitish_from in zip(tags[:-1], tags[1:]):
+        if args.type == "single" and args.tag != commitish_to:
+            continue
+
+        content.append(
+            changelog_part(
+                commitish_to,
+                commitish_from,
+                args.release if commitish_to == "HEAD" else commitish_to,
+            )
+        )
+        content.append("")
+
+    sys.stdout.write("\n".join(content))
+    sys.stdout.close()

sbin/changelog.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env python
+
+import argparse
+import sys
+import subprocess
+
+import utils
+
+
+parser = argparse.ArgumentParser(
+    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
+"""
+)
+parser.add_argument(
+    "range", metavar="RANGE", type=str, nargs="?", default="HEAD~..HEAD"
+)
+args = parser.parse_args()
+
+
+for sha in utils.cmd(["git", "rev-list", args.range]).split():
+    message = utils.cmd(["git", "log", "-1", "--format=%s", sha])
+    try:
+        data = utils.conventional_commit_parse(message)
+        print("ok:", message)
+    except:
+        print("ERROR:", message)
+        sys.exit(1)