pull-request-doc.yml

name: PR Documentation [synchronize]

on:
  pull_request:
    types:
      - synchronize
      - opened
      - reopened
    paths:
      - "documentation/**"
jobs:
  documentation:
    if: github.repository_owner == 'refinedev'
    runs-on: ubuntu-latest
    concurrency:
      group: ${{ github.ref }}-pr-doc
      cancel-in-progress: true
    strategy:
      matrix:
        node-version: [18.x]

    name: Deploy Documentation Preview

    steps:
      - uses: actions/checkout@v4
      - uses: pnpm/action-setup@v3
        with:
          version: 9
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node-version }}
          cache: "pnpm"
      - name: Add key to allow access to repository
        env:
          SSH_AUTH_SOCK: /tmp/ssh_agent.sock
        run: |
          mkdir -p ~/.ssh
          ssh-keyscan github.com >> ~/.ssh/known_hosts
          echo "${{ secrets.GH_PAGES_DEPLOY }}" > ~/.ssh/id_rsa
          chmod 600 ~/.ssh/id_rsa
          cat <<EOT >> ~/.ssh/config
          Host github.com
          HostName github.com
          IdentityFile ~/.ssh/id_rsa
          EOT
      - name: Install Package Dependencies
        run: |
          pnpm install
      - name: Install Doc Dependencies
        run: |
          cd documentation
          pnpm install
      - name: Wait for Netlify Deploy (Live Previews)
        uses: probablyup/wait-for-netlify-action@3.2.0
        id: waitForDeployment
        continue-on-error: true
        with:
          site_id: ${{ secrets.NETLIFY_PREVIEW_SITE_ID }}
          max_timeout: 1200
        env:
          NETLIFY_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
      - name: output test
        run: |
          echo ${{ steps.waitForDeployment.outputs.url }}
      - name: Build Documentation
        run: |
          cd documentation
          LIVE_PREVIEW_URL=${{ steps.waitForDeployment.outputs.url }}/preview pnpm build
      - name: Deploy to Netlify
        id: netlify-deploy
        uses: nwtgck/actions-netlify@v1.2
        with:
          publish-dir: "./documentation/build"
          github-token: ${{ secrets.PANKOD_BOT_TOKEN }}
          deploy-message: "Deploy from GitHub Actions"
          enable-pull-request-comment: false
          overwrites-pull-request-comment: false
          github-deployment-environment: "deploy-preview-website-${{ github.event.number }}"
        env:
          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
        timeout-minutes: 15
      - name: Check Existing Links in Documentation
        if: steps.netlify-deploy.outputs.deploy-url
        run: DEPLOY_URL=${{ steps.netlify-deploy.outputs.deploy-url }} SITEMAP_URL=https://refine.dev/sitemap.xml node ./.github/workflows/check-existing-doc-links.js