Automate Python tag-based PyPI releases

Author: Anonymous Committer

.github/workflows/generate.yml

@@ -1,4 +1,4 @@
-name: generate-sdks
+name: generate-python-sdk
 
 on:
   workflow_dispatch:
@@ -42,7 +42,7 @@ jobs:
         if: ${{ hashFiles('openapi/justserpapi.openapi.json') != '' }}
         uses: actions/upload-artifact@v4
         with:
-          name: generated-sdks
+          name: generated-python-sdk
           path: |
             .generated
             openapi/justserpapi.openapi.json

.github/workflows/python.yml

@@ -3,7 +3,7 @@
 #
 # ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: justserpapi Python package
+name: python-package
 
 on: [push, pull_request]
 
@@ -27,11 +27,11 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r test-requirements.txt
-          pip install -e .
+          pip install .
       - name: Validate docs and tests
         run: |
           python scripts/sdkctl.py validate-examples
-          pytest --cov=justserpapi
+          python -m unittest discover -s tests -v
       - name: Build distribution artifacts
         run: |
           python -m build

.github/workflows/release.yml

@@ -1,35 +1,60 @@
-name: release-sdks
+name: release-python
 
 on:
-  workflow_dispatch:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+  id-token: write
 
 jobs:
-  sync-and-push:
+  publish:
     runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/justserpapi/
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - uses: actions/setup-python@v5
         with:
           python-version: "3.11"
-      - uses: actions/setup-java@v4
-        with:
-          distribution: temurin
-          java-version: "21"
-      - name: Install orchestration dependencies
-        run: python -m pip install --upgrade pip
-      - name: Fetch canonical spec when it is not committed
-        if: ${{ hashFiles('openapi/justserpapi.openapi.json') == '' }}
-        env:
-          JUSTSERPAPI_API_KEY: ${{ secrets.JUSTSERPAPI_API_KEY }}
-        run: python scripts/sdkctl.py fetch-spec
-      - name: Require canonical spec
-        run: test -f openapi/justserpapi.openapi.json
-      - name: Generate release artifacts
+      - name: Install release dependencies
         run: |
-          python scripts/sdkctl.py validate-examples
-          python scripts/sdkctl.py validate-spec
-          python scripts/sdkctl.py generate --clean
-      - name: Sync SDK repositories
+          python -m pip install --upgrade pip
+          pip install -r test-requirements.txt
+          pip install .
+      - name: Verify tag and package version
+        run: python scripts/sdkctl.py verify-release --tag "${GITHUB_REF_NAME}"
+      - name: Validate docs
+        run: python scripts/sdkctl.py validate-examples
+      - name: Run tests
+        run: python -m unittest discover -s tests -v
+      - name: Build distribution artifacts
+        run: python -m build
+      - name: Check distribution metadata
+        run: python -m twine check dist/*
+      - name: Smoke install built wheel
         env:
-          SDK_REPO_PUSH_TOKEN: ${{ secrets.SDK_REPO_PUSH_TOKEN }}
-        run: python scripts/sdkctl.py sync-repos --push --tag
+          RELEASE_VERSION: ${{ github.ref_name }}
+        run: |
+          python -m venv .release-venv
+          . .release-venv/bin/activate
+          pip install dist/*.whl
+          python - <<'PY'
+          import os
+          import justserpapi
+
+          expected = os.environ["RELEASE_VERSION"].removeprefix("v")
+          assert justserpapi.__version__ == expected
+
+          client = justserpapi.Client(api_key="test-api-key")
+          assert type(client).__name__ == "Client"
+          assert type(client.google).__name__ == "GoogleResource"
+          client.close()
+          PY
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/validate.yml

@@ -21,7 +21,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r test-requirements.txt
-          pip install -e .
+          pip install .
       - name: Run orchestration tests
         run: python -m unittest discover -s tests -v
       - name: Validate documentation examples

README.md

@@ -93,7 +93,7 @@ client.close()
 
 ## OpenAPI Control Plane
 
-This repository is driven by the canonical OpenAPI document plus the SDK control-plane files in `config/`, `scripts/`, and `overlays/`.
+This repository only owns the Python SDK. The canonical OpenAPI document plus the Python-specific control-plane files in `config/`, `scripts/`, and `overlays/python/` drive generation and validation.
 
 - If `openapi/justserpapi.openapi.json` is committed, local generation is fully reproducible.
 - If it is not committed, CI can fetch and cache it by running `python scripts/sdkctl.py fetch-spec` with `JUSTSERPAPI_API_KEY` configured.
@@ -106,6 +106,19 @@ python scripts/sdkctl.py validate-spec --skip-generator-validate
 python scripts/sdkctl.py generate --clean
 ```
 
+## Release
+
+Official releases are tag-driven:
+
+```bash
+python scripts/sdkctl.py verify-release --tag vX.Y.Z
+git push origin vX.Y.Z
+```
+
+- The package version comes from `justserpapi/_version.py`
+- If `openapi/justserpapi.openapi.json` is committed, its `info.version` must match the tag and package version
+- GitHub Actions publishes tagged releases to PyPI through Trusted Publishing
+
 ## License
 
 Distributed under the MIT License. See `LICENSE` for more information.

config/generators/go.json

@@ -2,7 +2,7 @@
   "service": {
     "name": "justserpapi",
     "display_name": "JustSerpAPI",
-    "description": "OpenAPI-first SDK release control plane for JustSerpAPI.",
+    "description": "OpenAPI-first Python SDK release tooling for JustSerpAPI.",
     "default_server_url": "https://api.justserpapi.com"
   },
   "spec": {
@@ -15,10 +15,7 @@
     "cache_dir": ".cache/openapi-generator"
   },
   "release": {
-    "generated_dir": ".generated",
-    "repositories_dir": ".repositories",
-    "commit_message": "chore: regenerate SDKs from OpenAPI {{SPEC_VERSION}}",
-    "tag_name": "v{{SPEC_VERSION}}"
+    "generated_dir": ".generated"
   },
   "languages": {
     "python": {
@@ -35,42 +32,6 @@
         "remote": "git@github.com:justserpapi/justserpapi-python.git",
         "default_branch": "main"
       }
-    },
-    "java": {
-      "generator": "java",
-      "output_subdir": "java",
-      "config_template": "config/generators/java.json",
-      "overlay_dir": "overlays/java",
-      "package": {
-        "name": "justserpapi-java",
-        "registry": "maven-central"
-      },
-      "repo": {
-        "name": "justserpapi-java",
-        "remote": "git@github.com:justserpapi/justserpapi-java.git",
-        "default_branch": "main"
-      },
-      "group_id": "com.justserpapi",
-      "artifact_id": "justserpapi",
-      "invoker_package": "com.justserpapi.client",
-      "api_package": "com.justserpapi.client.api",
-      "model_package": "com.justserpapi.client.model"
-    },
-    "go": {
-      "generator": "go",
-      "output_subdir": "go",
-      "config_template": "config/generators/go.json",
-      "overlay_dir": "overlays/go",
-      "package": {
-        "name": "justserpapi",
-        "registry": "go-proxy"
-      },
-      "repo": {
-        "name": "justserpapi-go",
-        "remote": "git@github.com:justserpapi/justserpapi-go.git",
-        "default_branch": "main"
-      },
-      "module_name": "github.com/justserpapi/justserpapi-go"
     }
   }
 }

config/generators/java.json

@@ -1,6 +1,6 @@
 # OpenAPI Governance
 
-The canonical OpenAPI document is the product. Every language SDK is a derivative artifact.
+The canonical OpenAPI document is the product. This repository owns the Python SDK derived from it.
 
 ## Required conventions
 
@@ -30,5 +30,5 @@ The canonical OpenAPI document is the product. Every language SDK is a derivativ
 
 ## Repository policy
 
-- `justserpapi/`, `docs/`, and the current root Python package are legacy generated artifacts and not the future source of truth.
-- Future releases must come from `openapi/` plus `config/`, `scripts/`, and `overlays/`.
+- This repository is Python-only; it does not orchestrate Java, Go, or other SDK releases.
+- Future Python releases must come from `openapi/` plus `config/`, `scripts/`, and `overlays/python/`.