Skip to content

Commit f37ee40

Browse files
committed
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. get-woke/woke#252 woke has a limitation that doesn't allow ignoring lines of code, codespell allows for this. Replacing woke with codespell that provides a dictionary for replacing phrasing with recommended terms: https://github.com/codespell-project/codespell/blob/main/codespell_lib/data/dictionary_usage.txt It also supports using custom dictionaries so we can add to the list if we want For more information about inclusive naming initiative, see https://inclusivenaming.org/about/ Codespell also checks spelling, which is an advantage for system roles because a big part of our code is user-facing - task names, debug messages, readmes. `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 ``` Signed-off-by: Sergei Petrosian <[email protected]>
1 parent a4004b9 commit f37ee40

File tree

5 files changed

+25
-22
lines changed

5 files changed

+25
-22
lines changed

.codespellrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[codespell]
2+
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
3+
skip = tests,artifacts*,pylintrc
4+
builtin = usage
5+
ignore-multiline-regex = codespell:ignore-begin.*codespell:ignore-end

.github/workflows/ansible-test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,6 @@ jobs:
4343
- name: Run ansible-test
4444
uses: ansible-community/ansible-test-gh-action@release/v1
4545
with:
46-
testing-type: sanity # wokeignore:rule=sanity
46+
testing-type: sanity
4747
ansible-core-version: stable-2.17
4848
collection-src-directory: ${{ github.workspace }}/.tox/ansible_collections/${{ env.LSR_ROLE2COLL_NAMESPACE }}/${{ env.LSR_ROLE2COLL_NAME }}

.github/workflows/codespell.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Codespell configuration is within .codespellrc
2+
---
3+
name: Codespell
4+
on: # yamllint disable-line rule:truthy
5+
- pull_request
6+
permissions:
7+
contents: read
8+
jobs:
9+
codespell:
10+
name: Check for spelling errors
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
- name: Annotate locations with typos
16+
uses: codespell-project/codespell-problem-matcher@v1
17+
- name: Codespell
18+
uses: codespell-project/actions-codespell@v2

.github/workflows/woke.yml

Lines changed: 0 additions & 20 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# bootloader
22

3-
[![ansible-lint.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/ansible-test.yml) [![codeql.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/codeql.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/codeql.yml) [![markdownlint.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/markdownlint.yml) [![python-unit-test.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/python-unit-test.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/python-unit-test.yml) [![tft.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/tft_citest_bad.yml) [![woke.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/woke.yml)
3+
[![ansible-lint.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/ansible-test.yml) [![codeql.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/codeql.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/codeql.yml) [![codespell.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/codespell.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/codespell.yml) [![markdownlint.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/markdownlint.yml) [![python-unit-test.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/python-unit-test.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/python-unit-test.yml) [![tft.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/bootloader/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/bootloader/actions/workflows/tft_citest_bad.yml)
44

55
An Ansible role for bootloader and kernel command line management.
66

0 commit comments

Comments
 (0)