codespell.yml

name: codespell

on:
  push:
    branches:
      - development
      - main
  pull_request:
    branches:
      - development

permissions:
  contents: read

jobs:
  codespell:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          fetch-depth: 0

      - name: Setup Python
        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
        with:
          python-version: '3.10'

      - name: Cache pip
        uses: actions/cache@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
        with:
          # this path is specific to Ubuntu
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
          restore-keys: |
            ${{ runner.os }}-pip-
      - name: Install dependencies
        run: pip install -r .github/workflows/dependencies/requirements.txt

      - name: Run codespell
        run: |
          codespell -I .github/workflows/codespell_ignore.txt, --ignore-words=.github/workflows/codespell_ignore.txt src