documentation/.github/workflows/code-spell.yml at master · wolfSSL/documentation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
name: Codespell

on:
  push:
    branches: [ 'master' ]
  pull_request:
    branches: [ '*' ]
  workflow_dispatch:

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

jobs:
  codespell:
    name: Check for spelling errors
    runs-on: ubuntu-22.04
    timeout-minutes: 5
    steps:
      - uses: actions/checkout@v4

      - name: Run codespell
        uses: codespell-project/actions-codespell@v2.1
        with:
          check_filenames: true
          check_hidden: true
          # Words below are false positives, not typos:
          #   TE            - FIPS test requirement IDs, e.g. "TE.09.09.02"
          #   Thi           - from the example password "Thi$i$myPa$$w0rd"
          #   regist        - parameter name in wolfMQTT (SN_Register *regist)
          #   Writen        - Writen() wrapper from "Unix Network Programming"
          #   Challener     - author name (Challener D., A Practical Guide to TPM 2.0)
          #   cant          - verbatim wolfSSL error string "cant decode peer key"
          #   mot           - Renesas skmt.exe -filetype "mot" (Motorola S-record)
          #   callin        - verbatim wolfSentry example output
          #   Incomming     - verbatim lwIP echoserver example output
          #   psuedo        - verbatim wolfSSH client --help output
          ignore_words_list: TE,Thi,inter-operability,regist,Writen,Challener,cant,mot,callin,Incomming,psuedo
          skip: '.git'