Merge pull request #4 from maastrichtlawtech/fix/query-payload-keyerror

Fix/query payload keyerror

Author: shashankmc

.github/workflows/ci.yml

@@ -65,6 +65,7 @@ jobs:
           pytest tests/ --doctest-modules --junitxml=junit/test-results.xml --cov=src/echr_extractor --cov-report=xml --cov-report=html
 
   build:
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
     name: Build Python package
     runs-on: ubuntu-latest
     steps:
@@ -90,7 +91,7 @@ jobs:
           path: dist/
 
   pypi-publish:
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
     name: Publish to PyPI
     needs: build
     runs-on: ubuntu-latest
@@ -110,7 +111,7 @@ jobs:
         uses: pypa/gh-action-pypi-publish@release/v1
 
   github-release:
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
     name: Sign the Python distribution with Sigstore and upload them to GitHub Releases
     needs:
       - pypi-publish

RELEASE.md

@@ -146,6 +146,12 @@ write_to = "src/echr_extractor/_version.py"  # Auto-generate version file
 - Check that setuptools_scm is installed: `pip install setuptools_scm`
 - Verify pyproject.toml configuration is correct
 
+### "Local versions not allowed" error on PyPI?
+- **Cause**: setuptools_scm was generating versions with local identifiers (e.g., `1.0.47+abc123`)
+- **Solution**: The configuration now uses `local_scheme = "no-local-version"` to prevent this
+- **Prevention**: Only build from clean, tagged commits (GitHub Actions now only runs on tags)
+- **Manual fix**: Ensure working directory is clean before creating tags
+
 ## 📚 Additional Resources
 
 - [setuptools_scm Documentation](https://github.com/pypa/setuptools_scm)

pyproject.toml

@@ -108,3 +108,7 @@ disallow_untyped_defs = true
 
 [tool.setuptools_scm]
 write_to = "src/echr_extractor/_version.py"
+# Ensure clean versions for PyPI releases
+local_scheme = "no-local-version"
+# Use distance-based versioning for development
+fallback_version = "0.0.0"

scripts/release.py

@@ -64,6 +64,16 @@ def check_working_directory_clean():
         print("Error: Working directory is not clean. Please commit or stash changes.")
         print("Uncommitted changes:")
         print(result.stdout)
+        print("\nThis is required to ensure clean version numbers for PyPI releases.")
+        sys.exit(1)
+    
+    # Also check that we're on main branch
+    result = run_command("git branch --show-current")
+    current_branch = result.stdout.strip()
+    if current_branch != "main":
+        print(f"Error: You must be on the 'main' branch to create releases.")
+        print(f"Current branch: {current_branch}")
+        print("Please switch to main branch: git checkout main")
         sys.exit(1)