feat: implement GitHub Actions workflow for automatic changelog generation

Author: dataGriff

.github/workflows/changelog.yml

@@ -0,0 +1,72 @@
+name: Generate Changelog
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch: # Allow manual triggering
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch full history for changelog generation
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install git-cliff
+        uses: taiki-e/install-action@v2
+        with:
+          tool: git-cliff
+
+      - name: Check for changes since last changelog update
+        id: check_changes
+        run: |
+          # Get the last commit that modified CHANGELOG.md
+          LAST_CHANGELOG_COMMIT=$(git log -1 --format="%H" -- CHANGELOG.md 2>/dev/null || echo "")
+          
+          if [ -z "$LAST_CHANGELOG_COMMIT" ]; then
+            echo "No previous changelog found, generating full changelog"
+            echo "has_changes=true" >> $GITHUB_OUTPUT
+          else
+            # Check if there are commits since the last changelog update
+            COMMITS_SINCE=$(git rev-list --count ${LAST_CHANGELOG_COMMIT}..HEAD)
+            if [ "$COMMITS_SINCE" -gt 1 ]; then
+              echo "Found $COMMITS_SINCE commits since last changelog update"
+              echo "has_changes=true" >> $GITHUB_OUTPUT
+            else
+              echo "No new commits to add to changelog"
+              echo "has_changes=false" >> $GITHUB_OUTPUT
+            fi
+          fi
+
+      - name: Generate changelog
+        if: steps.check_changes.outputs.has_changes == 'true'
+        run: |
+          echo "Generating changelog..."
+          git-cliff --output CHANGELOG.md
+
+      - name: Check if changelog was updated
+        if: steps.check_changes.outputs.has_changes == 'true'
+        id: check_diff
+        run: |
+          if git diff --quiet CHANGELOG.md; then
+            echo "No changes to changelog"
+            echo "changelog_updated=false" >> $GITHUB_OUTPUT
+          else
+            echo "Changelog was updated"
+            echo "changelog_updated=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Commit and push changelog
+        if: steps.check_changes.outputs.has_changes == 'true' && steps.check_diff.outputs.changelog_updated == 'true'
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add CHANGELOG.md
+          git commit -m "docs: update changelog [skip ci]"
+          git push

CHANGELOG.md

@@ -32,6 +32,7 @@
 
 ### 🐛 Bug Fixes
 
+- Update timestamp format in changelog generation for consistency _(2025-10-16 12:10:15)_
 - Reorder links in README for better clarity and navigation _(2025-10-16 11:44:58)_
 - Clarify instructions for supporting codebase principles in documentation _(2025-10-15 20:44:41)_
 - Update upload-pages-artifact action to v3 in deploy-docs.yml _(2025-10-15 17:17:21)_

README.md

@@ -33,17 +33,10 @@ The codebase interface is a set of principles that aim to promote the ease of us
 To set up the development environment and enable automatic changelog generation:
 
 ```bash
-# Install dependencies and configure hooks
+# Install dependencies
 task setup
-
-# Or manually configure hooks
-task setup:hooks
 ```
 
-This will:
-
-- Install required dependencies (MkDocs, plugins)
-- Configure Git to use project hooks for automatic changelog generation
-- Enable pre-commit hook that updates CHANGELOG.md automatically
+This will install required dependencies (MkDocs, plugins) for local development.
 
-**Note**: The pre-commit hook automatically generates changelog entries from your conventional commits, so make sure to follow the [Conventional Commits](https://conventionalcommits.org) specification.
+**Note**: The changelog is automatically generated via GitHub Actions when commits are pushed to main. Make sure to follow the [Conventional Commits](https://conventionalcommits.org) specification for proper changelog generation.

Taskfile.yml

@@ -18,15 +18,15 @@ tasks:
       - pip install mkdocs-material
       - pip install mkdocs-git-revision-date-localized-plugin
       - pip install pymdown-extensions
-      - task: setup:hooks
+      - echo "Setup complete! Changelog is automatically generated via GitHub Actions."
     silent: true
 
   setup:hooks:
-    desc: Configure Git to use project hooks directory
+    desc: Configure Git to use project hooks directory (optional - changelog now generated via GitHub Actions)
     cmds:
       - git config core.hooksPath .githooks
       - chmod +x .githooks/pre-commit
-      - echo "Git hooks configured! Pre-commit hook is now active for changelog generation."
+      - echo "Git hooks configured! Note: Changelog is now automatically generated via GitHub Actions on push to main."
 
   build:
     desc: Build the MkDocs site