generate.yml

name: 🔄 Generate SDK

on:
  push:
    branches:
      - main
    paths:
      - '.github/workflows/generate.yml'
      - 'scripts/generate-sdk.mjs'
      - 'scripts/generate-types.mjs'
      - 'scripts/generate-strict-types.mjs'
  schedule:
    # At 07:23 on every day-of-week from Monday through Friday.
    - cron: '23 7 * * 1-5'
  workflow_dispatch:
    inputs:
      force:
        description: 'Force regeneration even if no changes detected'
        required: false
        default: false
        type: boolean

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions: {}


jobs:
  fetch_and_update:
    name: Sync OpenAPI definition
    runs-on: ubuntu-latest
    permissions:
      contents: write # To push generated SDK code
      pull-requests: write # To create PRs for review
    outputs:
      has_changes: ${{ steps.check.outputs.has_changes }}
    steps:
      - name: Random delay
        if: github.event_name == 'schedule'
        run: |
          # Add random delay between 0-10 minutes for scheduled runs
          delay=$((RANDOM % 600))
          echo "Sleeping for $delay seconds..."
          sleep $delay

      - uses: SocketDev/socket-registry/.github/actions/setup-and-install@da519693b701861bc0f9690a30f50af1a1dcd49c # main

      - name: Configure push credentials
        env:
          GH_TOKEN: ${{ github.token }}
        run: git remote set-url origin "https://x-access-token:${GH_TOKEN}@github.com/${{ github.repository }}.git"

      - uses: SocketDev/socket-registry/.github/actions/setup-git-signing@da519693b701861bc0f9690a30f50af1a1dcd49c # main
        with:
          gpg-private-key: ${{ secrets.BOT_GPG_PRIVATE_KEY }}

      - name: Generate SDK
        # Fetches OpenAPI, generates types/api.d.ts and src/types-strict.ts
        run: pnpm run generate-sdk

      - name: Check for changes
        id: check
        run: |
          if [ -n "$(git status --porcelain)" ]; then
            echo "has_changes=true" >> $GITHUB_OUTPUT
          else
            echo "has_changes=false" >> $GITHUB_OUTPUT
          fi

      - name: Commit and push changes
        if: steps.check.outputs.has_changes == 'true'
        run: |
          git checkout -b automated/open-api
          git add .
          git commit -m "fix(openapi): sync with openapi definition"
          git push origin automated/open-api -fu

      - name: Create Pull Request
        if: steps.check.outputs.has_changes == 'true'
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          # Check if PR already exists
          existing_pr=$(gh pr list --head automated/open-api --json number --jq '.[0].number' || echo "")

          if [ -z "$existing_pr" ]; then
            gh pr create \
              --head automated/open-api \
              --base main \
              --title "Sync with OpenAPI definition" \
              --body "## OpenAPI Sync

          The OpenAPI definition in the API has been updated. This PR automatically:
          - Downloads the latest OpenAPI specification
          - Regenerates TypeScript types (types/api.d.ts)
          - Regenerates strict TypeScript types (src/types-strict.ts)
          - Updates SDK method signatures if needed

          ### What's Changed
          See the file changes below for specific updates to the API types, strict types, and methods.

          **Please review carefully for any breaking changes in the API.**" \
              --label "dependencies" \
              --label "automated"
          else
            echo "PR #$existing_pr already exists, skipping creation"
          fi

      - uses: SocketDev/socket-registry/.github/actions/cleanup-git-signing@da519693b701861bc0f9690a30f50af1a1dcd49c # main
        if: always()

  validate:
    name: Validate generated SDK
    needs: fetch_and_update
    if: needs.fetch_and_update.outputs.has_changes == 'true'
    runs-on: ubuntu-latest
    permissions:
      contents: read
    outputs:
      has_changes: ${{ steps.check.outputs.has_changes }}
    steps:
      - uses: SocketDev/socket-registry/.github/actions/setup-and-install@da519693b701861bc0f9690a30f50af1a1dcd49c # main
        with:
          checkout-ref: automated/open-api

      - name: Build SDK
        run: pnpm run build

      - name: Type check
        run: pnpm run check

      - name: Lint
        run: pnpm run lint --all

      - name: Test
        run: pnpm run test --all

      - name: Check for API breaking changes
        run: |
          if git diff origin/main...HEAD --name-only | grep -q 'types/api.d.ts'; then
            echo "⚠️ API types have changed. Please review for breaking changes."
            git diff origin/main...HEAD types/api.d.ts | head -100
          fi