CI: added a check that CHANGELOG.md is modified on feature branches

Author: LostInDarkMath

.github/workflows/main.yml

@@ -1,59 +1,88 @@
 name: Python Tests
 
 on:
- push:
+  push:
     branches:
       - '*'
 
 jobs:
- test:
+  changelog-check:
+    # Do not run this on master itself
+    if: github.ref != 'refs/heads/master'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # we need history to diff properly
+
+      - &install-task  # define a YAML anchor to re-use this task in other jobs
+        name: Install task to make use of Taskfile.yml
+        run: |
+          sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin
+          task --version
+
+      - name: Verify CHANGELOG.md was updated
+        run: |
+          task check-changelog
+
+  test:
+    needs: changelog-check   # ensures this runs first
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [3.11, 3.12, 3.13, 3.14]
+
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-        check-latest: true
-    - name: Install task to make use of Taskfile.yml
-      run: |
-        sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin
-        task --version
-    - name: Install dependencies
-      run: |
-        task dependencies-with-pip
-        pip install -U coveralls
-    - name: Run tests with pytest
-      run: |
-        task tests-with-cov
-    - name: Coveralls
-      uses: coverallsapp/github-action@v2.3.6
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        file: .coverage
- deploy:
-   needs: test
-   runs-on: ubuntu-latest
-   if: github.ref == 'refs/heads/master'
-   environment:
-     name: pypi-deployment
-   steps:
-   - uses: actions/checkout@v4
-   - name: Set up Python
-     uses: actions/setup-python@v5
-     with:
-       python-version: 3.12
-   - name: Install Build Tools
-     run: |
-       pip install -U build twine
-   - name: Set Twine Environment Variables
-     run: |
-       echo "TWINE_USERNAME=${{ secrets.PYPI_USERNAME }}" >> $GITHUB_ENV
-       echo "TWINE_PASSWORD=${{ secrets.PYPI_PASSWORD }}" >> $GITHUB_ENV
-   - name: Build and Upload to PyPI
-     run: |
-       python -m build
-       twine upload dist/*
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          check-latest: true
+
+      - *install-task  # see above
+
+      - name: Install dependencies
+        run: |
+          task dependencies-with-pip
+          pip install -U coveralls
+
+      - name: Run tests with pytest
+        run: |
+          task tests-with-cov
+
+      - name: Coveralls
+        uses: coverallsapp/github-action@v2.3.6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          file: .coverage
+
+  deploy:
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+    environment:
+      name: pypi-deployment
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Install Build Tools
+        run: |
+          pip install -U build twine
+
+      - name: Set Twine Environment Variables
+        run: |
+          echo "TWINE_USERNAME=${{ secrets.PYPI_USERNAME }}" >> $GITHUB_ENV
+          echo "TWINE_PASSWORD=${{ secrets.PYPI_PASSWORD }}" >> $GITHUB_ENV
+
+      - name: Build and Upload to PyPI
+        run: |
+          python -m build
+          twine upload dist/*

CHANGELOG.md

@@ -10,6 +10,7 @@
 - added `Taskfile.yml` and use it in CI
 - removed `create_pdoc.sh`
 - moved `examples` out of the package
+- CI: added a check that `CHANGELOG.md` is modified on feature branches
 
 ## Pedantic 2.4.0
 - migrate from unittest to pytest

Taskfile.yml

@@ -24,10 +24,42 @@ tasks:
     desc: Runs the tests with coverage
     cmds:
       - pytest --doctest-modules --cov=pedantic --cov-branch --cov-report= --cov-report=term
+    silent: true
   docs:
     desc: Creates the HTML documentation
     cmds:
       - rm -rf ./docs
       - pip install pdoc
       - pdoc -o docs pedantic
       - google-chrome ./docs/index.html
+    silent: true
+  check-changelog:
+    desc: Fails if CHANGELOG.md was not modified compared to master
+    silent: true
+    cmds:
+      - |
+        set -e
+
+        echo "Checking that CHANGELOG.md was updated..."
+
+        # Ensure we have master available (works both locally and in CI)
+        if git show-ref --verify --quiet refs/remotes/origin/master; then
+          BASE=origin/master
+        elif git show-ref --verify --quiet refs/heads/master; then
+          BASE=master
+        else
+          echo "❌ Could not find master branch to diff against."
+          exit 1
+        fi
+
+        # Fetch latest master if we're in a repo with a remote
+        git fetch origin master >/dev/null 2>&1 || true
+
+        if git diff --name-only "$BASE"...HEAD | grep -qx "CHANGELOG.md"; then
+          echo "✅ CHANGELOG.md was updated."
+        else
+          echo "❌ CHANGELOG.md was NOT updated."
+          echo ""
+          echo "Please add an entry describing your change."
+          exit 1
+        fi