haproxy/.github/workflows/codespell.yml

name: Spelling Check

on:
  schedule:
    - cron: "0 0 * * 2"

permissions:
  contents: read

jobs:
  codespell:
    runs-on: ubuntu-latest
    if: ${{ github.repository_owner == 'haproxy' }}
    steps:
    - uses: actions/checkout@v4
    - uses: codespell-project/codespell-problem-matcher@v1.2.0
    - uses: codespell-project/actions-codespell@master
      with:
        skip: CHANGELOG,Makefile,*.fig,*.pem,./doc/design-thoughts,./doc/internals
        ignore_words_list: ist,ists,hist,wan,ca,cas,que,ans,te,nd,referer,ot,uint,iif,fo,keep-alives,dosen,ifset,thrid,strack,ba,chck,hel,unx,mor,clen,collet,bu,htmp,siz,experim
        uri_ignore_words_list: trafic,ressources
CI: Clean up formatting in GitHub Action definitions This patch cleans up the formatting within the .yml definition files for GitHub Actions to ensure a consistent look across all actions. 2021-10-16 16:10:27 +00:00			`name: Spelling Check`
CI: add spellcheck github action action is self consistent. it is scheduled to run weekly 2020-03-10 07:10:26 +00:00
			`on:`
Revert "CI: enable spell check on git push" This reverts commit 413aa6e2e94a591d444ef9bd174a99b64eea8436. It reports failures that neither the patch's author nor the committer are able to check for before pushing, causing an excess of failure reports that can hardly be acted upon. We need to find a better solution, let's revert it for now. 2024-01-26 18:58:14 +00:00			`schedule:`
			`- cron: "0 0 * * 2"`
CI: add spellcheck github action action is self consistent. it is scheduled to run weekly 2020-03-10 07:10:26 +00:00
CI: Add `permissions` to GitHub Actions This change locks down the permissions of the access token in GitHub Actions to only allow reading the repository contents and nothing else. see https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token 2021-10-16 16:10:26 +00:00			`permissions:`
			`contents: read`

CI: add spellcheck github action action is self consistent. it is scheduled to run weekly 2020-03-10 07:10:26 +00:00			`jobs:`
			`codespell:`
			`runs-on: ubuntu-latest`
CI: limit codespell checks to main repo, not forks 2023-11-21 18:54:17 +00:00			`if: ${{ github.repository_owner == 'haproxy' }}`
CI: add spellcheck github action action is self consistent. it is scheduled to run weekly 2020-03-10 07:10:26 +00:00			`steps:`
CI: Update to actions/checkout@v4 No functional change, but we should keep this current. see 5f4ddb54b05ae0355b1f64c22263a6bc381410df 2023-09-06 14:57:29 +00:00			`- uses: actions/checkout@v4`
CI: modernize codespell action, switch to node 16 The following actions uses node12 which is deprecated and will be forced to run on node16: codespell-project/codespell-problem-matcher@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/ 2024-08-13 19:11:30 +00:00			`- uses: codespell-project/codespell-problem-matcher@v1.2.0`
CI: refactor spelling check let us switch to codespell github actions instead of invocation from cmdline. also, "ifset,thrid,strack,ba,chck,hel,unx,mor" added to whitelist, those are variable names and special terms widely used in HAProxy 2022-01-07 09:42:54 +00:00			`- uses: codespell-project/actions-codespell@master`
			`with:`
CI: exclude doc/{design-thoughts,internals} from spell check as those directories do contain many documents written in French, codespell is catching a lot of false positives scanning them. 2023-04-01 10:27:31 +00:00			`skip: CHANGELOG,Makefile,.fig,.pem,./doc/design-thoughts,./doc/internals`
CI: extend spell check white list siz - seen in src/debug.c EXPERIM - seen in src/cli.c 2024-01-24 13:26:15 +00:00			`ignore_words_list: ist,ists,hist,wan,ca,cas,que,ans,te,nd,referer,ot,uint,iif,fo,keep-alives,dosen,ifset,thrid,strack,ba,chck,hel,unx,mor,clen,collet,bu,htmp,siz,experim`
CI: codespell: ignore some words in URLs "trafic,ressources" are found in URIs, due to https://github.com/codespell-project/actions-codespell/issues/55 we cannot use wildcard for exclusion, let start with fixed list 2024-01-11 19:49:09 +00:00			`uri_ignore_words_list: trafic,ressources`