appium/.github/workflows/docs.yml

name: Build Docs

on:
  pull_request:
    branches:
      - master
    paths:
      - '**/typedoc.json'
      - '**/tsconfig*.json'
      - '**/package*.json'
      - '**/*mkdocs*.ya?ml'
      - 'packages/docutils/requirements.txt'
      - 'packages/*/README.md'
      - 'packages/*/docs/**'
      - 'packages/*/**/*.ts'
      - 'packages/*/**/*.js'
      - '.github/workflows/docs.yml' # this file
      - '!**/test/**'
      - '!**/sample-code/**'
  push:
    branches:
      - master
    paths:
      - '**/typedoc.json'
      - '**/tsconfig*.json'
      - '**/package*.json'
      - '**/*mkdocs*.ya?ml'
      - 'packages/docutils/requirements.txt'
      - 'packages/*/README.md'
      - 'packages/*/docs/**'
      - 'packages/*/**/*.ts'
      - 'packages/*/**/*.js'
      - '.github/workflows/docs.yml' # this file
      - '!**/test/**'
      - '!**/sample-code/**'

jobs:
  docs:
    name: Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
      - name: Install dependencies (Node.js)
        uses: bahmutov/npm-install@1a235c31658a322a3b024444759650ee6345c26d # tag=v1
        with:
          useRollingCache: true
          install-command: npm ci
      - name: Install dependencies (Python)
        run: pip install -r packages/docutils/requirements.txt
      - name: Configure Git User
        run: |
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
          git config --local user.name "github-actions[bot]"
      - name: Build Docs
        run: npm run docs:preview