spelling.yml

# yaml-language-server: $schema=https://json.schemastore.org/github-workflow

name: "Spelling"
# I take care of your fat fingers and ESL mistakes.

on:  # yamllint disable-line rule:truthy
    pull_request: null
    push:
        branches:
        - "master"
    workflow_call: null

permissions: {}  # yamllint disable-line rule:braces
#permissions: "read-all"
#permissions:
#    contents: "read" # Private repositories need read permission

concurrency:
    group: "${{ github.workflow }}-${{ github.ref }}"
    cancel-in-progress: true

jobs:
    typos_check:
        name: "文A codespell"
        runs-on: "ubuntu-22.04"
        timeout-minutes: 1
        steps:
        -
            name: "Checkout repository"
            uses: "actions/checkout@v3.6.0"
        -
            name: "Cache pip"
            uses: "actions/cache@v3"
            with:
                path: "~/.cache/pip"
                key: "${{ runner.os }}-pip-codespell"
        -
            name: "Install codespell"
            run: |
                pip install --user 'codespell>=2.2'
        -
            name: "Search for misspellings"
            #uses: "codespell-project/actions-codespell@v2.0"
            #with:
            #    skip: "./.git,package-lock.json"
            #    check_hidden: true
            #    check_filenames: true
            #    builtin: "clear,rare,informal,usage,code,names"
            #    ignore_words_list: "master"
            run: |
                "$(python -m site --user-base)/bin/codespell" \
                    --skip="./.git,package-lock.json" \
                    --check-hidden \
                    --check-filenames \
                    --builtin="clear,rare,informal,usage,code,names" \
                    --ignore-words-list="master"