Automate OpenAPI sync releases

Author: Anonymous Committer

.github/workflows/release.yml

@@ -4,13 +4,26 @@ on:
   push:
     tags:
       - 'v*'
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Release tag to publish, for example v3.0.6'
+        required: true
+  repository_dispatch:
+    types:
+      - openapi-sdk-release
+
+env:
+  RELEASE_TAG: ${{ github.event.inputs.tag || github.event.client_payload.tag || github.ref_name }}
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.inputs.tag || github.event.client_payload.tag || github.ref_name }}
 
       - uses: actions/setup-python@v5
         with:
@@ -24,13 +37,13 @@ jobs:
 
       - name: Verify tag matches package version
         env:
-          GITHUB_REF_NAME: ${{ github.ref_name }}
+          RELEASE_TAG: ${{ env.RELEASE_TAG }}
         run: |
           python - <<'PY'
           import os
           from pathlib import Path
 
-          tag = os.environ["GITHUB_REF_NAME"]
+          tag = os.environ["RELEASE_TAG"]
           if not tag.startswith("v"):
               raise SystemExit(f"Release tags must start with 'v': {tag}")
 
@@ -93,7 +106,7 @@ jobs:
       - name: Create GitHub release
         uses: softprops/action-gh-release@v2
         with:
-          tag_name: ${{ github.ref_name }}
-          name: ${{ github.ref_name }}
+          tag_name: ${{ env.RELEASE_TAG }}
+          name: ${{ env.RELEASE_TAG }}
           files: dist/*
           generate_release_notes: true

.github/workflows/sync-openapi.yml

@@ -2,23 +2,33 @@ name: sync-openapi
 
 on:
   workflow_dispatch:
+  repository_dispatch:
+    types:
+      - openapi-updated
   schedule:
-    - cron: '0 2 * * *'
+    - cron: "*/15 * * * *"
+
+permissions:
+  contents: write
+
+concurrency:
+  group: sync-openapi
+  cancel-in-progress: false
 
 jobs:
   sync:
     if: github.repository == 'justoneapi/justoneapi-python'
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      pull-requests: write
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 0
 
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: "3.11"
 
       - name: Install dependencies
         run: python -m pip install -e '.[dev]'
@@ -44,11 +54,72 @@ jobs:
       - name: Build sync summary
         run: python scripts/diff_openapi.py "$RUNNER_TEMP/public-api.previous.json" openapi/public-api.json --output "$RUNNER_TEMP/openapi-sync-summary.md"
 
-      - name: Create pull request
-        uses: peter-evans/create-pull-request@v7
-        with:
-          branch: codex/openapi-sync
-          delete-branch: true
-          title: 'chore: sync OpenAPI spec and generated SDK'
-          commit-message: 'chore: sync OpenAPI spec and generated SDK'
-          body-path: ${{ runner.temp }}/openapi-sync-summary.md
+      - name: Detect SDK changes
+        id: changes
+        run: |
+          if git diff --quiet -- openapi/public-api.json openapi/public-api.normalized.json justoneapi/generated; then
+            echo "changed=false" >> "$GITHUB_OUTPUT"
+            echo "OpenAPI spec and generated SDK are already up to date."
+          else
+            echo "changed=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Bump package version
+        if: steps.changes.outputs.changed == 'true'
+        id: version
+        run: |
+          version="$(python scripts/bump_version.py)"
+          echo "version=${version}" >> "$GITHUB_OUTPUT"
+          echo "tag=v${version}" >> "$GITHUB_OUTPUT"
+          echo "Bumped package version to ${version}"
+
+      - name: Commit generated SDK update
+        if: steps.changes.outputs.changed == 'true'
+        env:
+          VERSION: ${{ steps.version.outputs.version }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add openapi/public-api.json openapi/public-api.normalized.json justoneapi/generated justoneapi/_version.py
+          {
+            echo "chore: sync OpenAPI spec and generated SDK v${VERSION}"
+            echo
+            cat "$RUNNER_TEMP/openapi-sync-summary.md"
+          } > "$RUNNER_TEMP/commit-message.txt"
+          git commit -F "$RUNNER_TEMP/commit-message.txt"
+
+      - name: Push main and release tag
+        if: steps.changes.outputs.changed == 'true'
+        env:
+          TAG: ${{ steps.version.outputs.tag }}
+        run: |
+          if git ls-remote --exit-code --tags origin "refs/tags/${TAG}" >/dev/null 2>&1; then
+            echo "Tag ${TAG} already exists on origin." >&2
+            exit 1
+          fi
+          for attempt in 1 2 3; do
+            git fetch --tags origin main
+            git rebase origin/main
+            git tag -f -a "${TAG}" -m "Release ${TAG}"
+            if git push --atomic origin HEAD:main "refs/tags/${TAG}"; then
+              exit 0
+            fi
+            git tag -d "${TAG}" || true
+            sleep 10
+          done
+          echo "Failed to push main and ${TAG} after 3 attempts." >&2
+          exit 1
+
+      - name: Trigger release workflow
+        if: steps.changes.outputs.changed == 'true'
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+          TAG: ${{ steps.version.outputs.tag }}
+        run: |
+          curl --fail-with-body --silent --show-error \
+            --request POST \
+            --header "Accept: application/vnd.github+json" \
+            --header "Authorization: Bearer ${GITHUB_TOKEN}" \
+            --header "X-GitHub-Api-Version: 2022-11-28" \
+            "https://api.github.com/repos/${GITHUB_REPOSITORY}/dispatches" \
+            --data "{\"event_type\":\"openapi-sdk-release\",\"client_payload\":{\"tag\":\"${TAG}\"}}"

scripts/bump_version.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+from __future__ import annotations
+
+import argparse
+import re
+from pathlib import Path
+
+DEFAULT_VERSION_PATH = Path("justoneapi/_version.py")
+VERSION_RE = re.compile(r'^__version__ = "(\d+)\.(\d+)\.(\d+)"\s*$')
+
+
+def bump_patch_version(path: Path) -> str:
+    content = path.read_text()
+    match = VERSION_RE.fullmatch(content.strip())
+    if not match:
+        raise ValueError(
+            f"{path} must contain a single __version__ = \"X.Y.Z\" assignment"
+        )
+
+    major, minor, patch = (int(part) for part in match.groups())
+    next_version = f"{major}.{minor}.{patch + 1}"
+    path.write_text(f'__version__ = "{next_version}"\n')
+    return next_version
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(description="Bump the package patch version.")
+    parser.add_argument("--path", type=Path, default=DEFAULT_VERSION_PATH)
+    args = parser.parse_args()
+
+    print(bump_patch_version(args.path))
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

tests/test_bump_version.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+import pytest
+
+from scripts.bump_version import bump_patch_version
+
+
+def test_bump_patch_version_updates_version_file(tmp_path):
+    version_path = tmp_path / "_version.py"
+    version_path.write_text('__version__ = "3.0.5"\n')
+
+    assert bump_patch_version(version_path) == "3.0.6"
+    assert version_path.read_text() == '__version__ = "3.0.6"\n'
+
+
+def test_bump_patch_version_rejects_unsupported_format(tmp_path):
+    version_path = tmp_path / "_version.py"
+    version_path.write_text('__version__ = "3.0.5.dev0"\n')
+
+    with pytest.raises(ValueError):
+        bump_patch_version(version_path)