refactor: Rework changelog formatting in git-cliff-release action (#135)

* Rework changelog formatting in git-cliff-release action

* Add print

* Missing --context

Author: janbuchar

.gitignore

@@ -1,3 +1,5 @@
 .DS_Store
 .idea
 .vscode
+.venv
+.mise.toml

git-cliff-release/action.yaml

@@ -86,9 +86,13 @@ runs:
         GIT_CLIFF_WORKDIR: ${{ github.action_path }}
         GITHUB_REPO: ${{ github.repository }}
         GH_TOKEN: ${{ github.token }}
+      working-directory: ${{ github.action_path }}
       run: |
         echo 'release_notes<<EOF' >> $GITHUB_OUTPUT
-        git-cliff --tag "${{ steps.version_number.outputs.tag_name }}" --unreleased --strip all | tee -a $GITHUB_OUTPUT
+        git-cliff --tag "${{ steps.version_number.outputs.tag_name }}" --unreleased --context | 
+          python enhance_context.py --repo $GITHUB_REPO --release-notes | 
+          git-cliff --from-context - --strip all |
+          tee -a $GITHUB_OUTPUT
         echo 'EOF' >> $GITHUB_OUTPUT
     - name: Generate changelog
       id: changelog
@@ -99,14 +103,19 @@ runs:
         GIT_CLIFF_WORKDIR: ${{ github.action_path }}
         GITHUB_REPO: ${{ github.repository }}
         GH_TOKEN: ${{ github.token }}
+      working-directory: ${{ github.action_path }}
       run: |
         if [[ ${{ inputs.release_type }} = prerelease ]]; then
           echo 'changelog<<EOF' >> $GITHUB_OUTPUT
-          git-cliff --with-tag-message "${{ steps.version_number.outputs.tag_name }}" >> $GITHUB_OUTPUT
+          git-cliff --context | 
+            python enhance_context.py --repo $GITHUB_REPO --unreleased-version "${{ steps.version_number.outputs.tag_name }}" | 
+            git-cliff --from-context - >> $GITHUB_OUTPUT
           echo 'EOF' >> $GITHUB_OUTPUT
         else
           echo 'changelog<<EOF' >> $GITHUB_OUTPUT
-          git-cliff --tag "${{ steps.version_number.outputs.tag_name }}" >> $GITHUB_OUTPUT
+          git-cliff --tag "${{ steps.version_number.outputs.tag_name }}" --context | 
+            python enhance_context.py --repo $GITHUB_REPO | 
+            git-cliff --from-context - >> $GITHUB_OUTPUT
           echo 'EOF' >> $GITHUB_OUTPUT
         fi
     - name: Clean up

git-cliff-release/cliff.toml

@@ -14,10 +14,12 @@ All notable changes to this project will be documented in this file.\n
 # template for the changelog body
 # https://keats.github.io/tera/docs/#introduction
 body = """
-{% if version %}\
-    ## [{{ version | trim_start_matches(pat="v") }}](<REPO>/releases/tag/{{ version }}) ({{ timestamp | date(format="%Y-%m-%d") }})
-{% elif message %}\
-    ## {{ message | trim_start_matches(pat="v") }} - **not yet released**
+{% if version and extra.release_link %}\
+    ## [{{ version | trim_start_matches(pat="v") }}]({{ extra.release_link }}) ({{ timestamp | date(format="%Y-%m-%d") }})
+{% elif extra.unreleased_version %}\
+    ## {{ extra.unreleased_version | trim_start_matches(pat="v") }} - **not yet released**
+{% elif version %}
+    ## {{ version | trim_start_matches(pat="v") }}
 {% else %}\
     ## unreleased
 {% endif %}\
@@ -26,8 +28,17 @@ body = """
     {% for commit in commits %}
         - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
             {% if commit.breaking %}[**breaking**] {% endif %}\
-            {{ commit.message | upper_first }} ([{{ commit.id | truncate(length = 7, end = "") }}](<REPO>/commit/{{ commit.id }}))\
-            {% if commit.remote.username %} by [@{{ commit.remote.username }}](https://github.com/{{ commit.remote.username }}){%- endif %}\
+            {% if commit.extra.pr_link %}\
+            {{ commit.message | upper_first | replace(from=commit.extra.raw_pr_link, to=commit.extra.pr_link) }}\
+            {% else %}\
+            {{ commit.message | upper_first }}\
+            {% endif %}\
+            {{" "}}([{{ commit.id | truncate(length = 7, end = "") }}]({{ commit.extra.commit_link }}))\
+            {% if commit.remote.username and extra.is_release_notes %}\
+            {{" "}}by @{{ commit.remote.username }}\
+            {% elif commit.remote.username %}\
+            {{" "}}by [@{{ commit.remote.username }}](https://github.com/{{ commit.remote.username }})\
+            {%- endif %}\
     {% endfor %}
 {% endfor %}\n
 """
@@ -38,9 +49,7 @@ footer = """
 # remove the leading and trailing s
 trim = true
 # postprocessors
-postprocessors = [
-  { pattern = '<REPO>', replace_command = 'sed "s^<REPO>^https://github.com/$GITHUB_REPO^g"' }, # replace repository URL
-]
+postprocessors = []
 
 [bump]
 # With 0.x.y version, breaking commits should only increase the minor version and feature commits should only increase the patch version
@@ -55,13 +64,7 @@ filter_unconventional = true
 # process each line of a commit as an individual commit
 split_commits = false
 # regex for preprocessing the commit messages
-commit_preprocessors = [
-  # Replace PR and issue numbers in commit messages
-  { pattern = '.*', replace_command = 'python $GIT_CLIFF_WORKDIR/preprocess_commit_message.py'},
-  # Check spelling of the commit with https://github.com/crate-ci/typos
-  # If the spelling is incorrect, it will be automatically fixed.
-  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
-]
+commit_preprocessors = []
 # regex for parsing and grouping commits
 commit_parsers = [
   { message = "^feat", group = "<!-- 0 -->🚀 Features" },

git-cliff-release/enhance_context.py

@@ -0,0 +1,88 @@
+from __future__ import annotations
+
+from argparse import ArgumentParser, BooleanOptionalAction
+import json
+import subprocess
+import sys
+from pathlib import Path
+from typing import Any
+
+
+def load_pr_issues(owner: str, repo: str) -> dict[int, list[int]]:
+    output = subprocess.check_output(
+        [
+            str(Path(__file__).parent / "fetch_pr_issues.sh"),
+            owner,
+            repo,
+        ]
+    )
+
+    try:
+        pr_issues = json.loads(output)
+    except ValueError:
+        print(f"fetch_pr_issues.sh output: {output}")
+        raise
+
+    return {int(key): value for key, value in pr_issues.items()}
+
+
+def enhance_release(
+    release: dict[str, Any], is_release_notes: bool, unreleased_version: str | None
+) -> None:
+    release["extra"] = release["extra"] or {}
+    release["extra"]["is_release_notes"] = is_release_notes
+
+    if release["version"]:
+        release["extra"]["release_link"] = (
+            f"{repo_url}/releases/tags/{release['version']}"
+        )
+    elif unreleased_version:
+        release["extra"]["unreleased_version"] = unreleased_version
+
+
+def enhance_commit(commit: dict[str, Any], pr_issues: dict[int, list[int]]) -> None:
+    pr_number = commit["remote"]["pr_number"]
+
+    commit["extra"] = commit["extra"] or {}
+    commit["extra"]["commit_link"] = f"{repo_url}/commit/{commit['id']}"
+
+    if pr_number:
+        commit["extra"]["closed_issues"] = pr_issues.get(pr_number, [])
+
+        commit["extra"]["raw_pr_link"] = f"(#{pr_number})"
+
+        pr_link = f"{repo_url}/pulls/{pr_number}"
+        issue_links = [
+            f"[#{issue}]({repo_url}/issues/{issue})"
+            for issue in commit["extra"]["closed_issues"]
+        ]
+
+        if issue_links:
+            commit["extra"]["pr_link"] = (
+                f"([#{pr_number}]({pr_link}, closes {', '.join(issue_links)}))"
+            )
+        else:
+            commit["extra"]["pr_link"] = f"([#{pr_number}]({pr_link}))"
+
+
+parser = ArgumentParser()
+parser.add_argument("--repo", type=str, required=True)
+parser.add_argument("--unreleased-version", nargs="?", default=None, type=str)
+parser.add_argument("--release-notes", action=BooleanOptionalAction)
+
+
+if __name__ == "__main__":
+    args = parser.parse_args()
+    repo_url = f"https://github.com/{args.repo}"
+    owner, repo = args.repo.split("/")
+
+    pr_issues = load_pr_issues(owner, repo)
+    context = json.load(sys.stdin)
+
+    for release in context:
+        enhance_release(release, args.release_notes, args.unreleased_version)
+
+        for commit in release["commits"]:
+            enhance_commit(commit, pr_issues)
+
+    json.dump(context, sys.stdout)

git-cliff-release/fetch_pr_issues.sh

@@ -1,7 +1,12 @@
 #!/bin/sh
 
-owner=$(echo $GITHUB_REPO | cut -d / -f 1)
-repo=$(echo $GITHUB_REPO | cut -d / -f 2)
+owner=$1
+repo=$2
+
+if [ -z "$owner" -o -z "$repo" ]; then
+    echo "Missing arguments - owner and repo" >&2
+    exit 1
+fi
 
 gh api graphql --paginate --slurp \
     -F owner="$owner" \
@@ -32,4 +37,4 @@ jq '
                 (.number | tostring):
                 [.closingIssuesReferences.nodes | .[] | .number]
             }
-    ] | add' > pullRequestIssues.json
+    ] | add'