chore(ci): adding missing hrefs in changelogs and added specs to benchmarks

Author: PyDataBlog

.github/workflows/CI.yml

@@ -393,3 +393,44 @@ jobs:
         run: cargo publish
         env:
           CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+
+  release:
+    name: Create GitHub Release
+    needs: [publish_to_pypi, publish]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # get all tags
+
+      - name: Get release notes
+        id: get_release_notes
+        run: |
+          # Get the latest tag
+          latest_tag=$(git describe --tags --abbrev=0)
+          echo "latest_tag=${latest_tag}" >> $GITHUB_ENV
+
+          # Extract release notes from CHANGELOG.md
+          # This script extracts the content between the latest tag and the previous tag.
+          notes=$(awk -v tag="## [${latest_tag##v}]" '
+            BEGIN { p = 0 }
+            $0 ~ tag { p = 1; next }
+            p && /^## / { exit }
+            p { print }
+          ' CHANGELOG.md)
+          echo "notes<<EOF" >> $GITHUB_OUTPUT
+          echo "$notes" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: ${{ env.latest_tag }}
+          name: "Release ${{ env.latest_tag }}"
+          body: ${{ steps.get_release_notes.outputs.notes }}
+          draft: false
+          prerelease: contains(github.ref, 'alpha') || contains(github.ref, 'beta')
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

benches/compare_benches.py

@@ -1,8 +1,20 @@
 import json
+import platform
 import sys
 from pathlib import Path
 
 import pandas as pd
+import psutil
+
+
+def get_system_specs():
+    return {
+        "OS": f"{platform.system()} {platform.release()}",
+        "Architecture": platform.machine(),
+        "CPU Model": platform.processor(),
+        "CPU Cores": f"{psutil.cpu_count(logical=True)} logical, {psutil.cpu_count(logical=False)} physical",
+        "Memory": f"{psutil.virtual_memory().total / (1024**3):.2f} GB",
+    }
 
 
 def compare_benchmarks():
@@ -36,6 +48,13 @@ def compare_benchmarks():
                 "This file is automatically generated by the CI. Do not edit manually.\n\n"
             )
 
+            # Add system specs
+            specs = get_system_specs()
+            f.write("## System Specifications\n\n")
+            for key, value in specs.items():
+                f.write(f"- **{key}:** {value}\n")
+            f.write("\n")
+
             for benchmark, group in df.groupby("benchmark"):
                 f.write(f"### {str(benchmark).capitalize()} Benchmark\n")
 

cliff.toml

@@ -19,7 +19,7 @@ body = """
 {% for group, commits in commits | group_by(attribute="group") %}
     ### {{ group | upper_first }}
     {% for commit in commits %}
-        - {% if commit.scope %}(**{{ commit.scope }}**) {% endif %}{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}])
+        - {% if commit.scope %}(**{{ commit.scope }}**) {% endif %}{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/PyDataBlog/simstring_rs/commit/{{ commit.id }}))
     {% endfor %}
 {% endfor %}
 
@@ -65,7 +65,6 @@ tag_pattern = "v[0-9].*"
 skip_tags = "v0.1.0-beta.1"
 # regex for ignoring tags
 ignore_tags = ""
-link_parsers = [
-  { pattern = "\\b[a-f0-9]{7}\\b", href = "https://github.com/PyDataBlog/simstring_rs/commit/$0" },
-  { pattern = "#(\\d+)", href = "https://github.com/PyDataBlog/simstring_rs/issues/$1" },
+commit_preprocessors = [
+  { pattern = "\\(#(\\d+)\\)", replace = "[#$1](https://github.com/PyDataBlog/simstring_rs/issues/$1)" },
 ]