supabase/.github/workflows/docs-js-libs-update.yml

name: Update JS Client Libraries Docs

on:
  workflow_dispatch:
    inputs:
      version:
        description: 'Version that was released (e.g., patch, minor, major, or v2.1.0)'
        required: true
        type: string
      source:
        description: 'Source of the documentation update'
        required: false
        type: string
        default: 'manual'

permissions:
  pull-requests: write
  contents: write

jobs:
  update-docs:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false
          ref: master

      - uses: pnpm/action-setup@0ebf47130e4866e96fce0953f49152a61190b271 # v6.0.9
        name: Install pnpm
        with:
          run_install: false

      - name: Use Node.js
        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
        with:
          node-version-file: '.nvmrc'
          cache: 'pnpm'

      - name: Install deps
        run: pnpm install --frozen-lockfile

      - name: Regenerate JS client libraries tsdoc files
        working-directory: apps/docs/spec
        env:
          SOURCE: ${{ github.event.inputs.source }}
          VERSION: ${{ github.event.inputs.version }}
        run: |
          echo "Regenerating tsdoc files for JS client libraries..."
          echo "Source: ${SOURCE}"
          echo "Version: ${VERSION}"
          make download.tsdoc.v2

      - name: Refresh reference-content snapshot
        working-directory: apps/docs
        # Using --dir (not a file path) so Vitest 4 doesn't run unrelated tests.
        run: npx vitest run --update --dir scripts

      - name: Generate token
        id: app-token
        uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
        with:
          client-id: ${{ vars.GH_AUTOFIX_APP_CLIENT_ID }}
          private-key: ${{ secrets.GH_AUTOFIX_PRIVATE_KEY }}
          permission-contents: write
          permission-pull-requests: write

      - name: Create pull request
        uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6.1.0
        with:
          token: ${{ steps.app-token.outputs.token }}
          commit-message: 'docs: update js sdk docs (${{ github.event.inputs.version }})'
          title: 'docs: update js sdk docs (${{ github.event.inputs.version }})'
          body: |
            Updates JS sdk documentation following stable release.
            Ran `make download.tsdoc.v2` in apps/docs/spec and refreshed the reference-content snapshot.

            **Details:**
            - **Version:** `${{ github.event.inputs.version }}`
            - **Source:** `${{ github.event.inputs.source }}`
            - **Changes:** Regenerated tsdoc files from latest spec files

            🤖 Auto-generated from @supabase/supabase-js stable release.
          branch: 'gha/update-js-sdk-docs-${{ github.run_number }}'
          base: 'master'