CI: added a check that the poetry package version was updated

Author: LostInDarkMath

.github/workflows/main.yml

@@ -6,8 +6,8 @@ on:
       - '*'
 
 jobs:
-  changelog-check:
-    # Do not run this on master itself
+  feature-branch-checks:
+    # these checks do not run this on master itself
     if: github.ref != 'refs/heads/master'
     runs-on: ubuntu-latest
 
@@ -26,8 +26,12 @@ jobs:
         run: |
           task check-changelog
 
+      - name: Verify that the package version was updated. This is needed because master is automatically deployed to pypi.org
+        run: |
+          task check-version
+
   test:
-    needs: changelog-check   # ensures this runs first
+    needs: feature-branch-checks
     runs-on: ubuntu-latest
     strategy:
       matrix:

CHANGELOG.md

@@ -11,6 +11,7 @@
 - removed `create_pdoc.sh`
 - moved `examples` out of the package
 - CI: added a check that `CHANGELOG.md` is modified on feature branches
+- CI: added a check that the poetry package version was updated 
 
 ## Pedantic 2.4.0
 - migrate from unittest to pytest

README.md

@@ -177,6 +177,7 @@ There are no hard dependencies. But if you want to use some advanced features yo
 
 ## Contributing
 This project is based on [poetry](https://python-poetry.org/) and [taskfile](https://taskfile.dev).
+**Tip:** Run `task validate` before making commits.
 
 ## Risks and side effects
 The usage of decorators may affect the performance of your application. 

Taskfile.yml

@@ -10,29 +10,48 @@ tasks:
       - poetry lock
       - poetry install --extras dev
     silent: true
+
   dependencies-with-pip:
     desc: Installs all dependencies using pip only
     cmds:
       - pip install --upgrade pip
       - pip install .[dev]
     silent: true
+
   tests:
     desc: Runs the tests
     cmds:
       - pytest --doctest-modules
+
   tests-with-cov:
     desc: Runs the tests with coverage
     cmds:
       - pytest --doctest-modules --cov=pedantic --cov-branch --cov-report= --cov-report=term
     silent: true
+
+  validate:
+    desc: Runs all checks and updates the docu. It is recommended to do this before making a commit.
+    cmds:
+      - task: check-changelog
+      - task: check-version
+      - task: tests
+      - task: generate-docs
+
   docs:
+    desc: Creates the HTML documentation and opens is Chrome
+    cmds:
+      - task: generate-docs
+      - google-chrome ./docs/index.html
+    silent: true
+
+  generate-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
@@ -63,3 +82,40 @@ tasks:
           echo "Please add an entry describing your change."
           exit 1
         fi
+
+  check-version:
+    desc: Fails if the version in pyproject.toml was not bumped compared to master
+    silent: true
+    cmds:
+      - |
+        set -e
+
+        echo "Checking that project version was updated..."
+
+        # Determine comparison base (works 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
+
+        # Try to fetch latest master (no-op if no remote available)
+        git fetch origin master >/dev/null 2>&1 || true
+
+        # Extract versions
+        CURRENT_VERSION=$(grep -E '^version\s*=' pyproject.toml | head -1 | sed -E 's/.*"(.*)".*/\1/')
+        BASE_VERSION=$(git show "$BASE:pyproject.toml" | grep -E '^version\s*=' | head -1 | sed -E 's/.*"(.*)".*/\1/')
+
+        echo "Base version:    $BASE_VERSION"
+        echo "Current version: $CURRENT_VERSION"
+
+        if [ "$CURRENT_VERSION" = "$BASE_VERSION" ]; then
+          echo "❌ Version was not updated."
+          echo "Please bump the version in pyproject.toml."
+          exit 1
+        fi
+
+        echo "✅ Version was updated."

docs/pedantic.html

@@ -27,7 +27,6 @@ <h2>Submodules</h2>
                     <li><a href="pedantic/constants.html">constants</a></li>
                     <li><a href="pedantic/decorators.html">decorators</a></li>
                     <li><a href="pedantic/env_var_logic.html">env_var_logic</a></li>
-                    <li><a href="pedantic/examples.html">examples</a></li>
                     <li><a href="pedantic/exceptions.html">exceptions</a></li>
                     <li><a href="pedantic/get_context.html">get_context</a></li>
                     <li><a href="pedantic/mixins.html">mixins</a></li>