From 75dc563b09065de047f83b83c19783f7cb27d9e6 Mon Sep 17 00:00:00 2001
From: Claude <noreply@anthropic.com>
Date: Tue, 3 Nov 2026 18:27:28 +0000
Subject: [PATCH] Release automatically when the version in setup.cfg changes

Add a release job to python-publish.yml that runs after the tests on
pushes to the default branch, reads the version from setup.cfg and,
when no tag of that name exists, creates the tag and the GitHub release
with generated notes. The build-n-publish job now waits for it and
uploads to PyPI when that tag was created in the same run, keeping a
tag pushed by hand as the alternative path. Document the process in a
Releasing section of the README.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
---
 .github/workflows/python-publish.yml | 58 +++++++++++++++++++++++++++-
 README.md                            | 10 +++++
 2 files changed, 66 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
index 51d7486..d6f34cd 100644
--- a/.github/workflows/python-publish.yml
+++ b/.github/workflows/python-publish.yml
@@ -31,9 +31,62 @@ jobs:
       run: |
         python -m pytest -m "not api"
 
+  release:
+    name: Tag and create the GitHub release
+    # Only pushes to the default branch can release; a version that is already tagged is left alone.
+    if: github.event_name == 'push' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+    needs: test
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+    concurrency:
+      group: release
+      cancel-in-progress: false
+    outputs:
+      tag: ${{ steps.version.outputs.tag }}
+      created: ${{ steps.release.outputs.created }}
+    steps:
+    - uses: actions/checkout@v7
+    - name: Read the version from setup.cfg
+      id: version
+      run: |
+        tag="$(sed -nE 's/^version *= *([^[:space:]]+).*/\1/p' setup.cfg | head -1)"
+        if [ -z "$tag" ]; then
+          echo "::error file=setup.cfg::no version found in setup.cfg"
+          exit 1
+        fi
+        echo "version $tag"
+        echo "tag=$tag" >> "$GITHUB_OUTPUT"
+    - name: Create the tag and the release unless the tag exists
+      id: release
+      env:
+        GH_TOKEN: ${{ github.token }}
+        TAG: ${{ steps.version.outputs.tag }}
+      run: |
+        status=0
+        git ls-remote --exit-code --tags origin "refs/tags/$TAG" > /dev/null || status=$?
+        case "$status" in
+          0)
+            echo "tag $TAG already exists, nothing to release"
+            echo "created=false" >> "$GITHUB_OUTPUT"
+            ;;
+          2)
+            gh release create "$TAG" --target "$GITHUB_SHA" --title "$TAG" --generate-notes
+            echo "created=true" >> "$GITHUB_OUTPUT"
+            ;;
+          *)
+            echo "::error::git ls-remote failed with exit code $status"
+            exit "$status"
+            ;;
+        esac
+
   build-n-publish:
     name: Build and publish to PyPI
-    if: github.event_name == 'push'
+    needs: [test, release]
+    # Runs for every push as before; the release job is skipped for tag pushes, hence the explicit result checks.
+    if: >-
+      !cancelled() && github.event_name == 'push' && needs.test.result == 'success'
+      && (needs.release.result == 'success' || needs.release.result == 'skipped')
     # kept on the same image as the test job
     runs-on: ubuntu-24.04
     steps:
@@ -60,7 +113,8 @@ jobs:
         build
         .
     - name: Publish to PyPI
-      if: startsWith(github.ref, 'refs/tags')
+      # a tag created by the release job in this run, or a tag pushed by hand
+      if: needs.release.outputs.created == 'true' || startsWith(github.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
         user: __token__
diff --git a/README.md b/README.md
index 77976cc..845ba0b 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,7 @@ Visit our [Documentation](https://docs.ipdata.co/) for more examples and tutoria
   - [Performance](#performance)
 - [Errors](#errors)
 - [Tests](#tests)
+- [Releasing](#releasing)
 
 ## Installation
 
@@ -791,3 +792,12 @@ The tests marked `api` call the live API and need an `IPDATA_API_KEY` environmen
 ```shell
 pytest -m "not api"
 ```
+
+## Releasing
+
+Releases are cut by CI from the version in `setup.cfg`:
+
+1. Bump `version` in `setup.cfg` in a pull request and merge it into `master`.
+2. CI runs the tests, tags the merge commit `x.y.z` (the version, with no `v` prefix), creates the GitHub release with generated notes and publishes the package to [PyPI](https://pypi.org/project/ipdata/).
+
+A merge whose version is already tagged publishes nothing. Pushing a tag by hand still builds and publishes that tag as before.