add version checking and release shortcut

Author: bckohan

.github/workflows/debug.yml

@@ -22,6 +22,8 @@ jobs:
     permissions:
       contents: read
 
+    env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ github.event.inputs.python-version }}

.github/workflows/release.yml

@@ -37,27 +37,36 @@ jobs:
       actions: write
     outputs:
       PACKAGE_NAME: ${{ steps.set-package.outputs.package_name }}
+      RELEASE_VERSION: ${{ steps.set-package.outputs.release_version }}
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
         python-version: ">=3.11"  # for tomlib
-    - name: Verify Tag Signature
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+    - name: Setup Just
+      uses: extractions/setup-just@v2
+    - name: Verify Tag
       run: |
         TAG_NAME=${GITHUB_REF#refs/tags/}
         echo "Verifying tag $TAG_NAME..."
         # if a tag was deleted and recreated we may have the old one cached
         # be sure that we're publishing the current tag!
         git fetch --force origin refs/tags/$TAG_NAME:refs/tags/$TAG_NAME
+
+        # verify signature
         curl -sL https://github.com/${{ github.actor }}.gpg | gpg --import 
         git tag -v "$TAG_NAME"
-    - name: Install uv
-      uses: astral-sh/setup-uv@v5
-      with:
-        enable-cache: true
-    - name: Setup Just
-      uses: extractions/setup-just@v2
+
+        # verify version
+        just verify_version $TAG_NAME
+
+        # export the release version
+        echo "RELEASE_VERSION=${TAG_NAME}" >> $GITHUB_ENV 
     - name: Build the binary wheel and a source tarball
       run: just build
     - name: Store the distribution packages

CONTRIBUTING.md

@@ -84,11 +84,10 @@ Additional dependency groups will need to be installed for some RDBMS:
     poetry install -E all --with oracle
 ```
 
-## Releases
+## Issuing Releases
 
-The release workflow is triggered by tag creation. You must have git tag signing enabled.
+The release workflow is triggered by tag creation. You must have [git tag signing enabled](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). Our justfile has a release shortcut:
 
 ```console
-git tag -s vX.X.X -m "X.X.X Release"
-git push origin vX.X.X
-```
+just release x.x.x
+```

justfile

@@ -205,3 +205,20 @@ coverage:
 # run the command in the virtual environment
 run +ARGS:
     uv run {{ ARGS }}
+
+
+# validate the given version string against the lib version
+[script]
+validate_version VERSION:
+    import re
+    import tomllib
+    import django_enum
+    assert re.match(r"\d+[.]\d+[.]\w+", "{{ VERSION }}")
+    assert "{{ VERSION }}" == tomllib.load(open('pyproject.toml', 'rb'))['project']['version']
+    assert "{{ VERSION }}" == django_enum.__version__
+
+# issue a relase for the given semver string (e.g. 2.1.0)
+release VERSION:
+    @just _validate_version {{ VERSION }}
+    git tag -s v{{ VERSION }} -m "{{ VERSION }} Release"
+    git push origin {{ VERSION }}