check.yaml

name: Check Updates

on:
  schedule:
    - cron: '0 06 * * 1-5'
  workflow_dispatch: # Allow manual triggering

jobs:
  check-version:
    runs-on: ubuntu-latest

    permissions:
      contents: write # Required for creating branches and PRs
      pull-requests: write # Required for creating PRs

    steps:
    - name: Checkout repository
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        fetch-depth: 0 # Fetch all history
        token: ${{ secrets.GITHUB_TOKEN }}

    - name: Set up Python
      uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
      with:
        python-version-file: '.python-version'

    - name: Install dependencies
      run: |
        pip install requests==2.32.5

    - name: Get OpenAPI version and check for existing PRs
      id: version_check
      run: |
        python << 'EOF'
        import requests
        import json
        import subprocess
        import sys
        import os

        def get_openapi_version():
            """Get version from OpenAPI spec"""
            try:
                response = requests.get('https://docs.reveng.ai/openapi.json', timeout=30)
                response.raise_for_status()
                openapi_data = response.json()
                return openapi_data.get('info', {}).get('version')
            except Exception as e:
                print(f"Error fetching OpenAPI spec: {e}")
                return None

        def check_existing_prs():
            """Check if there are existing open SDK-update PRs.

            Matches by branch prefix `sdk-update-`, which this workflow owns.
            Author-based filtering is unreliable: PRs are created via a GitHub
            App token (app/reveng-github), not the default github-actions bot.
            """
            try:
                result = subprocess.run([
                    'gh', 'pr', 'list', '--state', 'open',
                    '--search', 'head:sdk-update-',
                    '--json', 'number,title,headRefName'
                ], capture_output=True, text=True, check=True)

                prs = json.loads(result.stdout)
                matching = [pr for pr in prs if pr.get('headRefName', '').startswith('sdk-update-')]
                if matching:
                    for pr in matching:
                        print(f"  - #{pr['number']} {pr['title']} ({pr['headRefName']})")
                    return True
                return False
            except Exception as e:
                print(f"Error checking existing PRs: {e}")
                return True  # Assume PR exists to be safe

        # Main logic
        print("🔍 Getting OpenAPI version and checking for existing PRs...")

        # Get OpenAPI version
        openapi_version = get_openapi_version()

        if not openapi_version:
            print("❌ Could not retrieve OpenAPI version")
            sys.exit(1)

        print(f"📋 OpenAPI version: {openapi_version}")

        # Check for existing PRs
        if check_existing_prs():
            print("📋 Existing PR found, skipping SDK generation")
            with open(os.environ['GITHUB_OUTPUT'], 'a') as f:
                f.write(f"should_generate=false\n")
        else:
            print("✅ No existing PRs found, proceeding with SDK generation")
            with open(os.environ['GITHUB_OUTPUT'], 'a') as f:
                f.write(f"should_generate=true\n")
                f.write(f"openapi_version={openapi_version}\n")

        print("✅ Check completed")
        EOF
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

    # `disallowAdditionalPropertiesIfNotPresent: false` only covers schemas that
    # omit additionalProperties. For an explicit `additionalProperties: false` the
    # generator reads the OpenAPI 3.1 boolean schema inconsistently, so the
    # `additional_properties` catch-all silently comes and goes between spec
    # revisions. `true` has only one reading.
    - name: Fetch and normalise OpenAPI spec
      if: steps.version_check.outputs.should_generate == 'true'
      run: |
        curl -fsSL https://docs.reveng.ai/openapi.json -o openapi.json
        python3 - <<'PY'
        import json

        with open("openapi.json") as f:
            spec = json.load(f)

        for schema in spec.get("components", {}).get("schemas", {}).values():
            if not isinstance(schema, dict) or schema.get("additionalProperties") is not False:
                continue
            if schema.get("properties"):
                schema["additionalProperties"] = True
            else:
                # Empty-body schemas stay bare, otherwise they generate as
                # Dict[str, object] instead of object.
                del schema["additionalProperties"]

        with open("openapi.json", "w") as f:
            json.dump(spec, f)
        PY

    - name: Generate Python SDK
      if: steps.version_check.outputs.should_generate == 'true'
      uses: openapi-generators/openapitools-generator-action@b729d184e6b3459572c37c0e37f88a832e69b552 # v1
      with:
        generator: python
        generator-tag: 'v7.17.0'
        openapi-file: openapi.json
        config-file: config.yml
        template-dir: templates
        command-args: |
          --additional-properties=packageVersion=${{ steps.version_check.outputs.openapi_version }}

    - name: Check for changes
      if: steps.version_check.outputs.should_generate == 'true'
      id: check_changes
      env:
        OPENAPI_VERSION: ${{ steps.version_check.outputs.openapi_version }}
      run: |
        # Move generated files to the correct locations and clean up.
        # Tests are intentionally not regenerated (apiTests/modelTests are disabled);
        # the manual tests under test/ are preserved across SDK updates.
        rm -Rf docs && mv python-client/docs .
        rm -Rf revengai && mv python-client/revengai .
        rm -Rf README.md && mv python-client/README.md .
        rm -Rf python-client openapi.json

        # Store the SDK version
        echo "$OPENAPI_VERSION" > .sdk-version

        # Configure git
        git config user.name "github-actions[bot]"
        git config user.email "github-actions[bot]@users.noreply.github.com"

        # Check if there are any changes
        if git diff --quiet && git diff --cached --quiet; then
          echo "No changes detected in generated SDK"
          echo "has_changes=false" >> $GITHUB_OUTPUT
        else
          echo "Changes detected in generated SDK"
          echo "has_changes=true" >> $GITHUB_OUTPUT

          # Show what changed
          echo "Files changed:"
          git diff --name-only
          echo
          echo "Summary of changes:"
          git diff --stat
        fi

    - name: Generate a token
      if: steps.version_check.outputs.should_generate == 'true' && steps.check_changes.outputs.has_changes == 'true'
      id: generate-token
      uses: actions/create-github-app-token@29824e69f54612133e76f7eaac726eef6c875baf # v2.2.1
      with:
        app-id: ${{ secrets.REVENG_APP_ID }}
        private-key: ${{ secrets.REVENG_APP_PRIVATE_KEY }}
        owner: ${{ github.repository_owner }}
        repositories: |
          sdk-python

    - name: Create Pull Request
      if: steps.version_check.outputs.should_generate == 'true' && steps.check_changes.outputs.has_changes == 'true'
      env:
        GITHUB_TOKEN: ${{ steps.generate-token.outputs.token }}
        OPENAPI_VERSION: ${{ steps.version_check.outputs.openapi_version }}
      run: |
        # Create a new branch
        BRANCH_NAME="sdk-update-${OPENAPI_VERSION}"
        git checkout -b "$BRANCH_NAME"

        # Stage all changes
        git add .

        # Commit changes
        git commit -m "Update SDK to version ${OPENAPI_VERSION}

        - Generated from OpenAPI spec version ${OPENAPI_VERSION}
        - Auto-generated by GitHub Actions"

        # Push the branch
        git push -f origin "$BRANCH_NAME"

        # Create PR using GitHub CLI
        gh pr create \
          --title "🤖 Update SDK to version ${OPENAPI_VERSION}" \
          --body "## 🔄 Automated SDK Update

        This PR was automatically generated to update the Python SDK to match the latest OpenAPI specification.

        ### 📊 Version Information
        - **OpenAPI Spec Version**: \`${OPENAPI_VERSION}\`

        ### 🔧 Changes
        - Generated fresh SDK from [OpenAPI specification](https://docs.reveng.ai/openapi.json)
        - Updated package version to match OpenAPI spec version
        - All changes are auto-generated using openapi-generator

        ### ✅ Next Steps
        1. Review the generated changes
        2. Run tests to ensure compatibility
        3. Merge to trigger automatic PyPI publishing

        ---
        🤖 *This PR was created automatically by GitHub Actions*" \
          --head "$BRANCH_NAME" \
          --base main

        echo "✅ Pull request created successfully"
        echo "::notice title=PR Created::Created PR for SDK update to version ${OPENAPI_VERSION}"