docs-format-check.yml

name: docs format check

on:
  # trigger deployment on every PR to branch POLARDB_11_DEV in docs/
  pull_request:
    branches: [ POLARDB_11_DEV ]
    paths:
      - ".github/workflows/docs.yml"
      - "docs/**"
      - "package*"
  # trigger deployment manually
  workflow_dispatch:

jobs:
  docs:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
        with:
          # fetch all commits to get last updated time or other git log info
          fetch-depth: 0

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          # choose node.js version to use
          node-version: "16"

      # cache node_modules
      - name: Cache dependencies
        uses: actions/cache@v4
        id: yarn-cache
        with:
          path: |
            **/node_modules
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      # install dependencies if the cache did not hit
      - name: Install dependencies
        if: steps.yarn-cache.outputs.cache-hit != 'true'
        run: yarn --frozen-lockfile

      - name: Prettier check
        run: npx prettier --check docs/