chore: release of 0.5.28

Merge pull request #36 from Logic-py/develop

Author: Logic-py

.github/generate_changelog.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+generate_categorized_changelog() {
+  local previous_tag="$1"
+  local git_log_command
+
+  if [ -n "$previous_tag" ]; then
+    git_log_command="git log $previous_tag..HEAD"
+  else
+    git_log_command="git log"
+  fi
+
+  echo "## What's Changed"
+
+  # Features
+  echo "### 🚀 Features"
+  $git_log_command --pretty=format:"* %s (%h)" --reverse | grep "^* feat" || true
+
+  # Bug Fixes
+  echo -e "\n### 🐛 Bug Fixes"
+  $git_log_command --pretty=format:"* %s (%h)" --reverse | grep "^* fix" || true
+
+  # Documentation
+  echo -e "\n### 📚 Documentation"
+  $git_log_command --pretty=format:"* %s (%h)" --reverse | grep "^* docs" || true
+
+  # Other Changes
+  echo -e "\n### 🔧 Other Changes"
+  $git_log_command --pretty=format:"* %s (%h)" --reverse | grep -v "^* feat\|^* fix\|^* docs" || true
+}
+
+# Usage in workflow:
+# CHANGELOG=$(generate_categorized_changelog "$PREVIOUS_TAG")
+# echo "CHANGELOG<<EOF" >> $GITHUB_ENV
+# echo "$CHANGELOG" >> $GITHUB_ENV
+# echo "EOF" >> $GITHUB_ENV

.github/workflows/ci_check_release.yml

@@ -208,6 +208,25 @@ jobs:
             echo "URL=${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ env.VERSION }}" >> $GITHUB_ENV
           fi
 
+      - name: Generate Changelog
+        if: env.CREATE_RELEASE == 'true'
+        id: changelog
+        run: |
+          if [ -n "${{ env.PREV_TAG }}" ]; then
+            echo "CHANGELOG<<EOF" >> $GITHUB_ENV
+            echo "## What's Changed" >> $GITHUB_ENV
+            git log ${{ env.PREV_TAG }}..HEAD --pretty=format:"* %s (%h)" --reverse | while read -r line; do
+              echo "* ${line}" >> $GITHUB_ENV
+            done
+            echo "EOF" >> $GITHUB_ENV
+          else
+            echo "CHANGELOG<<EOF" >> $GITHUB_ENV
+            echo "## What's Changed" >> $GITHUB_ENV
+            git log --pretty=format:"* %s (%h)" --reverse | while read -r line; do
+              echo "* ${line}" >> $GITHUB_ENV
+            done
+            echo "
+
       - name: Debug Release Notes
         if: env.CREATE_RELEASE == 'true'
         run: |
@@ -223,6 +242,7 @@ jobs:
           tag_name: ${{ env.VERSION }}
           name: ${{ env.VERSION }}
           body: |
+            ${{ env.CHANGELOG }}
             **Full Changelog**: ${{ env.URL }}
           draft: false
           prerelease: false

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-template"
-version = "0.5.27"
+version = "0.5.28"
 description = "Used to templatize python projects."
 authors = ["Loïc Motheu <lmotheu@gmail.com>"]
 readme = "README.md"