codespell.yml

name: 'codespell'

on:
  push:
    branches:
    - 'main' # default branch
  pull_request: { }
  workflow_dispatch: { }

defaults:
  run:
    shell: bash

jobs:
  codespell:
    if: ${{
      (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/'))
      || (github.event_name == 'push' && !startsWith(github.event.head_commit.message, '[push-back]'))
      || github.event_name != 'push'
      }}
    runs-on: ubuntu-latest
    timeout-minutes: 30
    steps:
    - name: Checkout repository
      uses: actions/checkout@v4
      with:
        submodules: recursive
        fetch-depth: 1
    - name: Find ignore words file
      id: find-ignore-words-file
      run: |
        if [ -f ".codespellignore" ]; then
          echo "ignoreWordsFile = '.codespellignore'"
          echo 'ignoreWordsFile=true' >> $GITHUB_OUTPUT
        else
          echo "ignoreWordsFile = ''"
          echo 'ignoreWordsFile=' >> $GITHUB_OUTPUT
        fi
    - name: Execute codespell
      uses: codespell-project/actions-codespell@v2
      with:
        only_warn: 'true'
        ignore_words_file: ${{steps.find-ignore-words-file.outputs.ignoreWordsFile}}
        check_filenames: 'true'
        check_hidden: 'false'
        skip: './.git/**,./.yarn/**,./node_modules/**,./build/**,./dist/**,./coverage/**'