chore(ci): added missing hrefs in changelogs & added specs to benchmarks (#37)

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

* chore(ci): Added missing python package & cleaned PR template

Author: PyDataBlog

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,39 +1,38 @@
 ---
 name: Pull Request
 about: Propose a change to the project
-title: 'feat(scope): describe your change'
-labels: ''
-assignees: ''
-
+title: "feat(scope): describe your change"
+labels: ""
+assignees: ""
 ---
 
 **Description**
 
-Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. -->
 
 **Fixes** (issue)
 
 **Type of change**
 
-Please update the title of your PR to match the type of change. The title will be used for the commit message and the changelog.
-
-The `(scope)` is optional and refers to the part of the codebase you're changing (e.g., `feat(search)`, `fix(ci)`).
-
-- [ ] `fix`: A bug fix
-- [ ] `feat`: A new feature
-- [ ] `feat!`: A breaking change
-- [ ] `docs`: Documentation only changes
-- [ ] `chore`: Changes to the build process or auxiliary tools
-- [ ] `refactor`: A code change that neither fixes a bug nor adds a feature
-- [ ] `perf`: A code change that improves performance
-- [ ] `test`: Adding missing tests or correcting existing tests
-- [ ] `style`: Changes that do not affect the meaning of the code
-- [ ] `ci`: Changes to our CI configuration files and scripts
-- [ ] `revert`: Reverts a previous commit
+<!-- Please update the title of your PR to match the type of change. The title will be used for the commit message and the changelog. -->
+<!---->
+<!-- The `(scope)` is optional and refers to the part of the codebase you're changing (e.g., `feat(search)`, `fix(ci)`). -->
+
+<!-- - [ ] `fix`: A bug fix -->
+<!-- - [ ] `feat`: A new feature -->
+<!-- - [ ] `feat!`: A breaking change -->
+<!-- - [ ] `docs`: Documentation only changes -->
+<!-- - [ ] `chore`: Changes to the build process or auxiliary tools -->
+<!-- - [ ] `refactor`: A code change that neither fixes a bug nor adds a feature -->
+<!-- - [ ] `perf`: A code change that improves performance -->
+<!-- - [ ] `test`: Adding missing tests or correcting existing tests -->
+<!-- - [ ] `style`: Changes that do not affect the meaning of the code -->
+<!-- - [ ] `ci`: Changes to our CI configuration files and scripts -->
+<!-- - [ ] `revert`: Reverts a previous commit -->
 
 **How Has This Been Tested?**
 
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
+<!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. -->
 
 - [ ] Test A
 - [ ] Test B

.github/workflows/CI.yml

@@ -61,7 +61,7 @@ jobs:
           pip install uv
           uv venv
           source .venv/bin/activate
-          uv pip install simstring-fast pandas maturin tabulate
+          uv pip install simstring-fast pandas maturin tabulate psutil
           rm -rf target/wheels
           maturin build --release
           uv pip install target/wheels/*.whl
@@ -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)" },
 ]