feat: add structure changelog (#283)

* feat: add structure changelog

Author: perber

.github/workflows/release.yml

@@ -57,29 +57,12 @@ jobs:
           echo "Found previous tag: $PREVIOUS"
           echo "tag=$PREVIOUS" >> $GITHUB_OUTPUT
 
-      - name: Generate simple changelog from git commits
+      - name: Generate categorized changelog
         id: changelog
         run: |
-          git fetch --tags
-          echo "Validating tags: ${{ steps.latest.outputs.tag }} and ${{ github.ref_name }}"
-
-          # Validate the existence of the previous tag
-          if ! git rev-parse --verify ${{ steps.latest.outputs.tag }} >/dev/null 2>&1; then
-            echo "Error: Previous tag ${{ steps.latest.outputs.tag }} does not exist." >&2
-            exit 1
-          fi
-
-          # Validate the existence of the current tag
-          if ! git rev-parse --verify ${{ github.ref_name }} >/dev/null 2>&1; then
-            echo "Error: Current tag ${{ github.ref_name }} does not exist." >&2
-            exit 1
-          fi
-
-          echo "Generating changelog from commits between ${{ steps.latest.outputs.tag }} and ${{ github.ref_name }}"
-          LOG=$(git log ${{ steps.latest.outputs.tag }}..${{ github.ref_name }} --pretty=format:"- %s (%an)")
-          # Removed unused changelog.txt file creation
+          make changelog PREVIOUS=${{ steps.latest.outputs.tag }} CURRENT=${{ github.ref_name }}
           echo "changelog<<EOF" >> $GITHUB_OUTPUT
-          echo "$LOG" >> $GITHUB_OUTPUT
+          cat changelog.md >> $GITHUB_OUTPUT
           echo "EOF" >> $GITHUB_OUTPUT
 
       - name: Publish GitHub Release

Makefile

@@ -64,6 +64,14 @@ endif
 		--tag ghcr.io/$(REPO_OWNER)/leafwiki:latest \
 		--push .
 
+# Generate markdown changelog between two tags
+changelog:
+	@if [ -z "$(PREVIOUS)" ] || [ -z "$(CURRENT)" ]; then \
+		echo "Usage: make changelog PREVIOUS=v0.1.0 CURRENT=v0.2.0"; \
+		exit 1; \
+	fi
+	@./scripts/changelog.sh $(PREVIOUS) $(CURRENT)
+
 help:
 	@echo "Available commands:"
 	@echo "  make build      – Build binary for current system"
@@ -72,5 +80,6 @@ help:
 	@echo "  make test       – Run all Go tests"
 	@echo "  make run        – Run development server"
 	@echo "  make docker-build-publish    – Build and push multi-arch Docker image"
+	@echo "  make changelog – Generate changelog"
 
-.PHONY: all build run clean test fmt lint help docker-build-publish
+.PHONY: all build run clean test fmt lint help docker-build-publish changelog

scripts/changelog.sh

@@ -0,0 +1,122 @@
+#!/usr/bin/env bash
+
+# -----------------------------------------------------------------------------
+# changelog.sh
+#
+# Purpose:
+#   Generates a categorized changelog in markdown format from git commit messages
+#   between two tags.
+#
+# Expected commit message format:
+#   Uses Conventional Commits prefixes for categorization:
+#     feat:      New features
+#     fix:       Bug fixes
+#     docs:      Documentation changes
+#     refactor:  Code refactoring
+#     test:      Test-related changes
+#     chore:     Maintenance tasks
+#   Any commit not matching these prefixes is categorized as "Other Changes".
+#
+# Usage:
+#   ./changelog.sh <previous_tag> <current_tag>
+#
+# Output:
+#   Writes a markdown changelog to 'changelog.md' in the current directory.
+# -----------------------------------------------------------------------------
+set -euo pipefail
+
+# === Configuration ===
+PREVIOUS_TAG="${1:-}"
+CURRENT_TAG="${2:-}"
+
+if [[ -z "$PREVIOUS_TAG" || -z "$CURRENT_TAG" ]]; then
+  echo "Usage: $0 <previous_tag> <current_tag>"
+  exit 1
+fi
+
+echo "🔍 Generating changelog from $PREVIOUS_TAG → $CURRENT_TAG"
+
+# Validate tags exist
+if ! git rev-parse --verify "$PREVIOUS_TAG" >/dev/null 2>&1; then
+  echo "❌ Previous tag '$PREVIOUS_TAG' does not exist."
+  exit 1
+fi
+if ! git rev-parse --verify "$CURRENT_TAG" >/dev/null 2>&1; then
+  echo "❌ Current tag '$CURRENT_TAG' does not exist."
+  exit 1
+fi
+
+# Collect commits
+COMMITS=$(git log "$PREVIOUS_TAG".."$CURRENT_TAG" --pretty=format:"%s (@%an)")
+
+# Categorize exclusively
+FEATURES=""
+FIXES=""
+DOCS=""
+REFACTOR=""
+TESTS=""
+CHORES=""
+OTHERS=""
+while IFS= read -r commit; do
+  if [[ "$commit" =~ ^feat ]]; then
+    FEATURES+="$commit"$'\n'
+  elif [[ "$commit" =~ ^fix ]]; then
+    FIXES+="$commit"$'\n'
+  elif [[ "$commit" =~ ^docs ]]; then
+    DOCS+="$commit"$'\n'
+  elif [[ "$commit" =~ ^refactor ]]; then
+    REFACTOR+="$commit"$'\n'
+  elif [[ "$commit" =~ ^test ]]; then
+    TESTS+="$commit"$'\n'
+  elif [[ "$commit" =~ ^chore ]]; then
+    CHORES+="$commit"$'\n'
+  else
+    OTHERS+="$commit"$'\n'
+  fi
+done <<< "$COMMITS"
+
+# Build markdown file
+OUTFILE="changelog.md"
+
+{
+  echo "## 📝 Changelog for $CURRENT_TAG"
+  echo ""
+
+  if [ -n "$FEATURES" ]; then
+    echo "### ✨ Features"
+    echo "$FEATURES" | sed '/^$/d; s/^/- /'
+    echo ""
+  fi
+  if [ -n "$FIXES" ]; then
+    echo "### 🐛 Bug Fixes"
+    echo "$FIXES" | sed '/^$/d; s/^/- /'
+    echo ""
+  fi
+  if [ -n "$DOCS" ]; then
+    echo "### 🧾 Documentation"
+    echo "$DOCS" | sed '/^$/d; s/^/- /'
+    echo ""
+  fi
+  if [ -n "$REFACTOR" ]; then
+    echo "### 🔧 Refactoring"
+    echo "$REFACTOR" | sed '/^$/d; s/^/- /'
+    echo ""
+  fi
+  if [ -n "$TESTS" ]; then
+    echo "### 🧪 Tests"
+    echo "$TESTS" | sed '/^$/d; s/^/- /'
+    echo ""
+  fi
+  if [ -n "$CHORES" ]; then
+    echo "### 🧰 Chores"
+    echo "$CHORES" | sed '/^$/d; s/^/- /'
+    echo ""
+  fi
+  if [ -n "$OTHERS" ]; then
+    echo "### 🔹 Other Changes"
+    echo "$OTHERS" | sed '/^$/d; s/^/- /'
+    echo ""
+  fi
+} > "$OUTFILE"
+
+echo "✅ Changelog written to $OUTFILE"