build-docs-preview.yaml

name: Build docs preview
# This job builds and deploys documenation to github pages.
# It runs on every push to master with a change in the docs folder.
on:
  pull_request:
    paths:
      - "docs/**"
      - "x/**/*.md"
      - .github/workflows/deploy-docs.yml

jobs:
  Build-preview:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v3
        with:
          persist-credentials: false
          fetch-depth: 0
          path: "."

      - name: Setup Node.js 🔧
        uses: actions/setup-node@v3
        with:
          node-version: "16.x"
          cache: 'yarn'
          cache-dependency-path: |
            docs/yarn.lock

      - name: Build 🔧
        run: make build-docs && mv ~/output ./output

      - name: Deploy preview to Netlify 🚀
        id: deploy-preview
        uses: nwtgck/actions-netlify@v2.0
        with:
          publish-dir: ./output
          deploy-message: "Deploy from GitHub Actions"
          enable-commit-comment: false
          enable-pull-request-comment: false
          overwrites-pull-request-comment: false
        env:
          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

      - name: Comment preview URL 🗨️
        if: env.GIT_DIFF
        uses: thollander/actions-comment-pull-request@v2
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          message: '👀 Docs preview available here: ${{ steps.deploy-preview.outputs.deploy-url }}'
          comment_tag: '👀 Docs preview available here: '