Merge pull request #2675 from carsakiller/log-changes

add: workflow to assert changelog updates

.github/scripts/check-changelog.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+CHANGELOG_FILE="changelog.md"
+
+git fetch origin $GITHUB_BASE_REF
+git fetch
+
+# Check if the changelog file was modified in the PR
+if git diff --name-only origin/$GITHUB_BASE_REF..remotes/pull/$GITHUB_SOURCE_REF | grep -q $CHANGELOG_FILE; then
+  echo "Thank you for updating the changelog!"
+  exit 0
+else
+  echo "Changelog has not been updated. Please update $CHANGELOG_FILE!"
+  exit 1
+fi

.github/workflows/changelog.yml

@@ -0,0 +1,24 @@
+name: changelog
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+    branches:
+      - master
+
+jobs:
+  check-changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up environment
+        run: |
+          echo "GITHUB_SOURCE_REF=${{ github.ref_name }}" >> $GITHUB_ENV
+          echo "GITHUB_BASE_REF=${{ github.base_ref }}" >> $GITHUB_ENV
+
+      - name: Check if changelog is updated
+        run: .github/scripts/check-changelog.sh

changelog.md

@@ -1,5 +1,8 @@
 # changelog
 
+## Unreleased
+<!-- Add all new changes here. They will be moved under a version at release -->
+
 ## 3.9.0
 `2024-5-11`
 * `NEW` goto implementation
@@ -123,7 +126,7 @@
     Cat = 1,
     Dog = 2,
   }
-  
+
   ---@param animal userdata
   ---@param atp AnimalType
   ---@return boolean