spellcheck.yaml

name: Spell Checker

on:
  pull_request:
    branches:
      - main

jobs:
  spellcheck:
    name: Spell Check on changed doc files
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20.x
          cache: yarn
      - name: Install dependencies
        run: yarn install --immutable
      - name: Get changed files in the docs folder
        id: changed-files-specific
        uses: tj-actions/changed-files@v44
        with:
          files: docs/**
          separator: '\n'
      - name: Spell check if any file(s) in the docs folder change
        if: steps.changed-files-specific.outputs.any_changed == 'true'
        env:
          ALL_CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }}
        run: |
          printf "$ALL_CHANGED_FILES" | yarn spellcheck-on-pr