From 55fc7d36ec50bd6a3c5aa48fc77addac44219cf2 Mon Sep 17 00:00:00 2001 From: Sergei Petrosian Date: Fri, 7 Feb 2025 14:09:11 +0100 Subject: [PATCH] ci: Replace woke with codespell woke has been left with Noriko's and all other PRs not being reviewed for years, hence we have been using our fork. Replacing woke with codespell to detect non-inclusive language Codespell provides a built-in dictionary with recommended non-inclusive terms: https://github.com/codespell-project/codespell/blob/main/codespell_lib/data/dictionary_usage.txt Codespell supports using custom dictionaries so we can add to the list if we want. `ignore-multiline-regex` in the `.codespellrc` config allows for disabling codespell for a block of lines: ``` # codespell:ignore-begin ... codespell will not look at this text. # codespell:ignore-end ``` You can ignore words inline by adding a comment like `# codespell:ignore word`. You can ignore files and directories, or words by adding them to config file `.codespellrc`. linux-system-roles do NOT use codespell to check spelling in code. For more information about inclusive naming initiative, see https://inclusivenaming.org/about/ Signed-off-by: Sergei Petrosian --- .codespellrc | 4 +++ .github/workflows/ansible-test.yml | 2 +- .github/workflows/codespell.yml | 30 +++++++++++++++++++ .../detect_non_inclusive_language.yml | 30 +++++++++++++++++++ .github/workflows/woke.yml | 20 ------------- README.md | 2 +- 6 files changed, 66 insertions(+), 22 deletions(-) create mode 100644 .codespellrc create mode 100644 .github/workflows/codespell.yml create mode 100644 .github/workflows/detect_non_inclusive_language.yml delete mode 100644 .github/workflows/woke.yml diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..f7c80cf --- /dev/null +++ b/.codespellrc @@ -0,0 +1,4 @@ +[codespell] +builtin = usage +ignore-multiline-regex = codespell:ignore-begin.*codespell:ignore-end +context=0 diff --git a/.github/workflows/ansible-test.yml b/.github/workflows/ansible-test.yml index 4dbdaa2..c9868a2 100644 --- a/.github/workflows/ansible-test.yml +++ b/.github/workflows/ansible-test.yml @@ -43,6 +43,6 @@ jobs: - name: Run ansible-test uses: ansible-community/ansible-test-gh-action@release/v1 with: - testing-type: sanity # wokeignore:rule=sanity + testing-type: sanity ansible-core-version: stable-2.17 collection-src-directory: ${{ github.workspace }}/.tox/ansible_collections/${{ env.LSR_ROLE2COLL_NAMESPACE }}/${{ env.LSR_ROLE2COLL_NAME }} diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000..693b4c5 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,30 @@ +# Codespell configuration is within .codespellrc +--- +name: Codespell +on: # yamllint disable-line rule:truthy + - pull_request +permissions: + contents: read +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Get variable with regex values + id: regexvar + run: | + curl -L -s -o dictionary_usage.txt https://raw.githubusercontent.com/codespell-project/codespell/refs/heads/main/codespell_lib/data/dictionary_usage.txt + regexvar=$(sed 's/->.*//g' dictionary_usage.txt | sed 's/$/|/' | tr -d '\n' | sed 's/.$//') + rm dictionary_usage.txt + echo "regexvar=$regexvar" >> "$GITHUB_OUTPUT" + + - name: Show errors from codespell as annotation in GitHub Actions + uses: codespell-project/codespell-problem-matcher@v1 + + - name: Codespell + uses: spetrosi/actions-codespell@add-regex-input + with: + regex: ${{ steps.regexvar.outputs.regexvar }} diff --git a/.github/workflows/detect_non_inclusive_language.yml b/.github/workflows/detect_non_inclusive_language.yml new file mode 100644 index 0000000..4f35355 --- /dev/null +++ b/.github/workflows/detect_non_inclusive_language.yml @@ -0,0 +1,30 @@ +# Codespell configuration is within .codespellrc +--- +name: Detect non-inclusive language +on: # yamllint disable-line rule:truthy + - pull_request +permissions: + contents: read +jobs: + codespell: + name: Detect non-inclusive language + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Get variable with regex values + id: regexvar + run: | + curl -L -s -o dictionary_usage.txt https://raw.githubusercontent.com/codespell-project/codespell/refs/heads/main/codespell_lib/data/dictionary_usage.txt + regexvar=$(sed 's/->.*//g' dictionary_usage.txt | sed 's/$/|/' | tr -d '\n' | sed 's/.$//') + rm dictionary_usage.txt + echo "regexvar=$regexvar" >> "$GITHUB_OUTPUT" + + - name: Show errors from codespell as annotation in GitHub Actions + uses: codespell-project/codespell-problem-matcher@v1 + + - name: Detect non-inclusive language with codespell + uses: spetrosi/actions-codespell@add-regex-input + with: + regex: ${{ steps.regexvar.outputs.regexvar }} diff --git a/.github/workflows/woke.yml b/.github/workflows/woke.yml deleted file mode 100644 index 4cded0d..0000000 --- a/.github/workflows/woke.yml +++ /dev/null @@ -1,20 +0,0 @@ ---- -# yamllint disable rule:line-length -name: Woke -on: # yamllint disable-line rule:truthy - - pull_request -jobs: - woke: - name: Detect non-inclusive language - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Run lsr-woke-action - # Originally, uses: get-woke/woke-action@v0 - uses: linux-system-roles/lsr-woke-action@main - with: - woke-args: "-c https://raw.githubusercontent.com/linux-system-roles/tox-lsr/main/src/tox_lsr/config_files/woke.yml --count-only-error-for-failure" - # Cause the check to fail on any broke rules - fail-on-error: true diff --git a/README.md b/README.md index 043b201..a14916f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # tlog -[![ansible-lint.yml](https://github.com/linux-system-roles/tlog/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/tlog/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/ansible-test.yml) [![markdownlint.yml](https://github.com/linux-system-roles/tlog/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/markdownlint.yml) [![tft.yml](https://github.com/linux-system-roles/tlog/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/tlog/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/tft_citest_bad.yml) [![woke.yml](https://github.com/linux-system-roles/tlog/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/woke.yml) +[![ansible-lint.yml](https://github.com/linux-system-roles/tlog/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/tlog/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/ansible-test.yml) [![codespell.yml](https://github.com/linux-system-roles/tlog/actions/workflows/codespell.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/codespell.yml) [![detect_non_inclusive_language.yml](https://github.com/linux-system-roles/tlog/actions/workflows/detect_non_inclusive_language.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/detect_non_inclusive_language.yml) [![markdownlint.yml](https://github.com/linux-system-roles/tlog/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/markdownlint.yml) [![tft.yml](https://github.com/linux-system-roles/tlog/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/tlog/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/tlog/actions/workflows/tft_citest_bad.yml) This role configures a system for [Terminal session recording](https://github.com/scribery). The role will configure tlog to log