spell-check.yaml

name: Spell Check

# =======================
# Automated Spell Checking
# =======================
# Purpose: Checks for spelling errors in pull requests using codespell
# Triggers: PR opened, synchronized, or reopened; manual dispatch for full check
# Reports: Comments on PR with potential typos and suggestions

on:
  pull_request:
    types: [opened, synchronize, reopened]
  workflow_dispatch:
    inputs:
      check_all:
        description: 'Check all website content (not just changed files)'
        required: false
        default: true
        type: boolean

env:
  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"

permissions:
  contents: read
  issues: write
  pull-requests: write

jobs:
  spell-check:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Get changed files (PR only)
        id: changed_files
        if: github.event_name == 'pull_request'
        run: |
          # Get list of changed files in the PR
          CHANGED_FILES=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep -E '\.(md|txt|html|yaml|yml|py|js|json|toml)$' || true)
          echo "files<<EOF" >> $GITHUB_OUTPUT
          echo "$CHANGED_FILES" >> $GITHUB_OUTPUT
          echo "EOF" >> $GITHUB_OUTPUT

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.x'

      - name: Install codespell
        run: |
          python -m pip install --upgrade pip
          pip install codespell

      - name: Run Spell Check Script
        id: spell_check
        env:
          CHECK_ALL: ${{ github.event_name == 'workflow_dispatch' && inputs.check_all == true }}
          CHANGED_FILES: ${{ steps.changed_files.outputs.files }}
        run: |
          python scripts/spell_check/check_spelling.py

      - name: Find Comment
        if: github.event_name == 'pull_request'
        uses: peter-evans/find-comment@v3
        id: fc
        with:
          issue-number: ${{ github.event.pull_request.number }}
          comment-author: 'github-actions[bot]'
          body-includes: Spell Check

      - name: Create or update comment
        if: github.event_name == 'pull_request'
        uses: peter-evans/create-or-update-comment@v4
        with:
          comment-id: ${{ steps.fc.outputs.comment-id }}
          issue-number: ${{ github.event.pull_request.number }}
          body: ${{ steps.spell_check.outputs.comment }}
          edit-mode: replace