docs.yml

name: SDK Type Docs Specification
on:
  workflow_dispatch:
  repository_dispatch:
    types: [new_release]

jobs:
  # Build job
  build:
    # run only when release succeeded
    concurrency: ci-${{ github.ref }}
    runs-on: ubuntu-latest
    steps:
    - name: Checkout 🛎️
      uses: actions/checkout@v4

    - name: Install and Build 🔧
      run: |
        yarn install --frozen-lockfile
        yarn docs
    - uses: actions/upload-artifact@v4
      with:
        name: page
        path: docs

  # Deploy job
  deploy:
    runs-on: ubuntu-latest
    needs: build

    permissions:
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Download ⚙️
        uses: actions/download-artifact@v4
        with:
          name: page
          path: .

      - name: Setup Pages 📑
        uses: actions/configure-pages@v5

      - name: Upload artifact 🗂
        uses: actions/upload-pages-artifact@v3
        with:
          path: .

      - name: Deploy to GitHub Pages 🚀
        id: deployment
        uses: actions/deploy-pages@v4