spelling.yaml

name: SpellCheck

on:
  pull_request:
    types:
      # default
      - opened
      - synchronize
      - reopened
      # re-run if base branch is changed, since previous merge commit may generate incorrect diff
      - edited

permissions:
  contents: read

jobs:
  spellcheck:
    name: SpellCheck
    runs-on: ubuntu-slim

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
        with:
          fetch-depth: 2

      - name: Run spelling check
        run: |
          ./eng/common/scripts/check-spelling-in-changed-files.ps1 `
              -CSpellConfigPath 'cspell.json' `
              -SourceCommittish HEAD `
              -TargetCommittish HEAD^ `
              -SpellCheckRoot (Resolve-Path specification) `
              -ExitWithError
          if ($LASTEXITCODE) {
            Write-Host "Spelling errors found in changed files. See https://aka.ms/ci-fix#spell-check"
            exit $LASTEXITCODE
          }
        shell: pwsh