sync-docs.yml

name: Sync API Docs
on:
  push:
    paths:
      - "docs/**"
    branches: ["main"]
  workflow_dispatch:

jobs:
  generate-api-docs:
    if: github.repository == 'raycast/extensions'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          fetch-depth: 2

      - name: Setup Node.js
        uses: raycast/github-actions/setup-node@master

      - name: Setup git
        uses: raycast/github-actions/setup-git@master

      - name: Fetch the latest types
        run: |
          configJson=`cat ./docs/.config.json`
          version=`echo $(jq -r '.version' <<< "$configJson")`
          curl -o types.d.ts "https://unpkg.com/@raycast/api@$version/types/index.d.ts"

      - name: Generate the docs
        run: |
          npm_config_yes=true npx @raycast/generate-docs --docs=./docs --types=./types.d.ts --output=./generated-docs
          rm types.d.ts

      - name: Deploy the generated docs to the gh-pages branch
        uses: peaceiris/actions-gh-pages@v3
        with:
          personal_token: ${{ secrets.RAYCAST_BOT_API_ACCESS_TOKEN }}
          publish_dir: ./generated-docs

      - name: Notify Failure to Slack
        if: failure()
        uses: edge/simple-slack-notify@master
        with:
          color: "danger"
          text: ":no_entry_sign: ${env.GITHUB_WORKFLOW} has failed"
          fields: |
            [
              { "title": "Action logs:", "value": "${env.GITHUB_SERVER_URL}/${env.GITHUB_REPOSITORY}/actions/runs/${env.GITHUB_RUN_ID}"},
              { "title": "Commit:", "value": "${env.GITHUB_SERVER_URL}/${env.GITHUB_REPOSITORY}/commit/${ env.GITHUB_SHA }"}
            ]
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_RELEASE_CHANNEL_WEBHOOK_URL }}

  sync-api-docs-with-upstream:
    if: github.repository == 'raycast/extensions'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          fetch-depth: 2

      - name: Setup Node.js
        uses: raycast/github-actions/setup-node@master

      - name: Get changed files in the docs folder
        id: changed-files
        uses: tj-actions/changed-files@v19
        with:
          files: |
            docs/**
            !docs/.config.json

      - name: Setup git
        uses: raycast/github-actions/setup-git@master

      - name: Update the docs in the main repo
        if: steps.changed-files.outputs.any_changed == 'true' || steps.changed-files.outputs.any_deleted == 'true'
        id: commit
        env:
          API_TOKEN_GITHUB: ${{ secrets.RAYCAST_BOT_API_ACCESS_TOKEN }}
        run: |
          ###########################
          # sync docs
          ###########################

          echo "🛠️ Syncing to main repo..."

          cd ${{ github.workspace }}

          git clone --single-branch --branch "master" "https://$API_TOKEN_GITHUB@github.com/raycast/raycast-macos.git" "raycast-macos"

          for file in ${{ steps.changed-files.outputs.deleted_files }}; do
            echo "Removing raycast-macos/Commands/$file"
            # If it's already removed, that's ok
            rm "raycast-macos/Commands/$file" || true
          done

          for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
            echo "Updating raycast-macos/Commands/$file"
            # If this fails, it's because there is a space in the filename
            # so it's from GitBook messing things up. Ignore it
            rsync -arv "$file" "raycast-macos/Commands/$file" || true
          done

          cd raycast-macos

          if [[ $(git diff --stat) != '' ]]; then
            git checkout -b docs-sync-${{ github.sha }}
            git add .
            git commit -m 'API Docs: Update from the extensions repo'
            git push origin docs-sync-${{ github.sha }}
            echo '::set-output name=has_commit::true'
          else
            echo 'No changes'
            echo '::set-output name=has_commit::false'
          fi

      - name: Open PR on the main repo
        uses: actions/github-script@v5
        if: steps.commit.outputs.has_commit == 'true'
        with:
          github-token: ${{ secrets.RAYCAST_BOT_API_ACCESS_TOKEN }}
          script: |
            github.rest.pulls.create({
              owner: 'raycast',
              repo: 'raycast-macos',
              head: 'docs-sync-${{ github.sha }}',
              base: 'master',
              title: 'API Docs: Update from the extensions repo'
            })

      - name: Notify Failure to Slack
        if: failure()
        uses: edge/simple-slack-notify@master
        with:
          color: "danger"
          text: ":no_entry_sign: ${env.GITHUB_WORKFLOW} has failed"
          fields: |
            [
              { "title": "Action logs:", "value": "${env.GITHUB_SERVER_URL}/${env.GITHUB_REPOSITORY}/actions/runs/${env.GITHUB_RUN_ID}"},
              { "title": "Commit:", "value": "${env.GITHUB_SERVER_URL}/${env.GITHUB_REPOSITORY}/commit/${ env.GITHUB_SHA }"}
            ]
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_RELEASE_CHANNEL_WEBHOOK_URL }}