ci: Replace woke with codespell

.ansible-lint

@@ -17,7 +17,7 @@ kinds:
 skip_list:
   - fqcn-builtins
   - var-naming[no-role-prefix]
-  - sanity[cannot-ignore]  # wokeignore:rule=sanity
+  - sanity[cannot-ignore]
 exclude_paths:
   - tests/roles/
   - .github/

.codespellrc

@@ -0,0 +1,5 @@
+[codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = tests,artifacts*,pylintrc
+builtin = usage
+ignore-multiline-regex = codespell:ignore-begin.*codespell:ignore-end

.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 }}

.github/workflows/codespell.yml

@@ -0,0 +1,18 @@
+# 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: Annotate locations with typos
+        uses: codespell-project/codespell-problem-matcher@v1
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

README.md

@@ -1,11 +1,9 @@
 # timesync
 
-[![ansible-lint.yml](https://github.com/linux-system-roles/timesync/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/timesync/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/ansible-test.yml) [![markdownlint.yml](https://github.com/linux-system-roles/timesync/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/markdownlint.yml) [![shellcheck.yml](https://github.com/linux-system-roles/timesync/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/shellcheck.yml) [![tft.yml](https://github.com/linux-system-roles/timesync/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/timesync/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/tft_citest_bad.yml) [![woke.yml](https://github.com/linux-system-roles/timesync/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/woke.yml)
+[![ansible-lint.yml](https://github.com/linux-system-roles/timesync/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/timesync/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/ansible-test.yml) [![codespell.yml](https://github.com/linux-system-roles/timesync/actions/workflows/codespell.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/codespell.yml) [![markdownlint.yml](https://github.com/linux-system-roles/timesync/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/markdownlint.yml) [![shellcheck.yml](https://github.com/linux-system-roles/timesync/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/shellcheck.yml) [![tft.yml](https://github.com/linux-system-roles/timesync/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/timesync/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/timesync/actions/workflows/tft_citest_bad.yml)
 
 This role installs and configures an NTP and/or PTP implementation to operate
-<!--- wokeignore:rule=slave -->
-as an NTP client and/or PTP slave in order to synchronize the system clock with
-<!--- wokeignore:rule=master -->
+as an NTP client and/or PTP slave in order to synchronize the system clock with <!-- codespell:ignore slave -->
 NTP servers and/or grandmasters in PTP domains. Supported NTP/PTP
 implementations are chrony, ntp (the reference implementation) and linuxptp.
 
@@ -65,7 +63,6 @@ timesync_ptp_domains:
   - number: 0                   # PTP domain number
     interfaces: [eth0]          # List of interfaces in the domain
     delay: 0.000010             # Assumed maximum network delay to the
-                                # grandmaster in seconds # wokeignore:rule=master
                                 # (default 100 microsecond)
     transport: UDPv4            # Network transport: UDPv4, UDPv6, L2
                                 # (default UDPv4)
@@ -143,7 +140,6 @@ Install and configure ntp to synchronize the system clock with three NTP servers
 ```
 
 Install and configure linuxptp to synchronize the system clock with a
-<!--- wokeignore:rule=master -->
 grandmaster in PTP domain number 0, which is accessible on interface eth0:
 
 ```yaml

handlers/main.yml

@@ -19,9 +19,7 @@
     name: phc2sys
     state: restarted
 
-# wokeignore:rule=master
 - name: Restart timemaster
   service:
-    # wokeignore:rule=master
     name: timemaster
     state: restarted

tasks/main.yml

@@ -137,7 +137,6 @@
     dest: "{{ timesync_chrony_conf_path }}"
     backup: true
     mode: "0644"
-  # wokeignore:rule=master
   notify: Restart {{ 'chronyd' if timesync_mode == 1 else 'timemaster' }}
   when:
     - timesync_mode != 2
@@ -162,7 +161,6 @@
     dest: /etc/ntp.conf
     backup: true
     mode: "0644"
-  # wokeignore:rule=master
   notify: Restart {{ 'ntpd' if timesync_mode == 1 else 'timemaster' }}
   when:
     - timesync_mode != 2
@@ -217,16 +215,12 @@
     - "'linuxptp' in ansible_facts.packages"
     - timesync_phc2sys_sysconfig_path | length > 0
 
-# wokeignore:rule=master
 - name: Generate timemaster.conf file
   template:
-    # wokeignore:rule=master
     src: timemaster.conf.j2
-    # wokeignore:rule=master
     dest: "{{ timesync_timemaster_config_path }}"
     backup: true
     mode: "0644"
-  # wokeignore:rule=master
   notify: Restart timemaster
   when:
     - timesync_mode == 3
@@ -327,10 +321,8 @@
     - not __disable_result.msg is match(
       'Could not find the requested service phc2sys:')
 
-# wokeignore:rule=master
 - name: Disable timemaster
   vars:
-    # wokeignore:rule=master
     __timemstr: timemaster
   service:
     name: "{{ __timemstr }}"
@@ -379,10 +371,8 @@
     - timesync_mode == 2
     - timesync_mode2_hwts
 
-# wokeignore:rule=master
 - name: Enable timemaster
   service:
-    # wokeignore:rule=master
     name: timemaster
     state: started
     enabled: true

templates/ptp4l.conf.j2

@@ -2,7 +2,6 @@
 {{ "system_role:timesync" | comment(prefix="", postfix="") }}
 
 [global]
-{# wokeignore:rule=slave #}
 slaveOnly		1
 domainNumber		{{ timesync_ptp_domains[0].number }}
 time_stamping		{{ 'hardware' if timesync_mode2_hwts else 'software' }}

templates/timemaster.conf.j2

@@ -18,7 +18,6 @@ ptp4l_option hybrid_e2e 1
 {% endif %}
 
 {% endfor %}
-{# wokeignore:rule=master #}
 [timemaster]
 ntp_program {{ 'ntpd' if timesync_ntp_provider == 'ntp' else 'chronyd' }}
 

vars/Debian.yml

@@ -6,5 +6,4 @@ timesync_chrony_conf_path: "/etc/chrony/chrony.conf"
 timesync_ntp_sysconfig_path: "/etc/default/ntp"
 timesync_ptp4l_sysconfig_path: ""
 timesync_phc2sys_sysconfig_path: ""
-# wokeignore:rule=master
 timesync_timemaster_config_path: "/etc/linuxptp/timemaster.conf"

vars/RedHat_10.yml

@@ -6,5 +6,4 @@ timesync_chrony_conf_path: "/etc/chrony.conf"
 timesync_ntp_sysconfig_path: /etc/sysconfig/ntpd
 timesync_ptp4l_sysconfig_path: /etc/sysconfig/ptp4l
 timesync_phc2sys_sysconfig_path: /etc/sysconfig/phc2sys
-# wokeignore:rule=master
 timesync_timemaster_config_path: /etc/timemaster.conf

vars/RedHat_6.yml

@@ -6,5 +6,4 @@ timesync_chrony_conf_path: "/etc/chrony.conf"
 timesync_ntp_sysconfig_path: /etc/sysconfig/ntpd
 timesync_ptp4l_sysconfig_path: /etc/sysconfig/ptp4l
 timesync_phc2sys_sysconfig_path: /etc/sysconfig/phc2sys
-# wokeignore:rule=master
 timesync_timemaster_config_path: /etc/timemaster.conf

vars/RedHat_7.yml

@@ -6,5 +6,4 @@ timesync_chrony_conf_path: "/etc/chrony.conf"
 timesync_ntp_sysconfig_path: /etc/sysconfig/ntpd
 timesync_ptp4l_sysconfig_path: /etc/sysconfig/ptp4l
 timesync_phc2sys_sysconfig_path: /etc/sysconfig/phc2sys
-# wokeignore:rule=master
 timesync_timemaster_config_path: /etc/timemaster.conf

vars/RedHat_8.yml

@@ -6,5 +6,4 @@ timesync_chrony_conf_path: "/etc/chrony.conf"
 timesync_ntp_sysconfig_path: /etc/sysconfig/ntpd
 timesync_ptp4l_sysconfig_path: /etc/sysconfig/ptp4l
 timesync_phc2sys_sysconfig_path: /etc/sysconfig/phc2sys
-# wokeignore:rule=master
 timesync_timemaster_config_path: /etc/timemaster.conf

vars/RedHat_9.yml

@@ -6,5 +6,4 @@ timesync_chrony_conf_path: "/etc/chrony.conf"
 timesync_ntp_sysconfig_path: /etc/sysconfig/ntpd
 timesync_ptp4l_sysconfig_path: /etc/sysconfig/ptp4l
 timesync_phc2sys_sysconfig_path: /etc/sysconfig/phc2sys
-# wokeignore:rule=master
 timesync_timemaster_config_path: /etc/timemaster.conf

vars/SL-Micro.yml

@@ -6,5 +6,4 @@ timesync_chrony_conf_path: "/etc/chrony.conf"
 timesync_ntp_sysconfig_path: /etc/sysconfig/ntpd
 timesync_ptp4l_sysconfig_path: /etc/sysconfig/ptp4l
 timesync_phc2sys_sysconfig_path: /etc/sysconfig/phc2sys
-# wokeignore:rule=master
 timesync_timemaster_config_path: /etc/timemaster.conf

vars/default.yml

@@ -6,5 +6,4 @@ timesync_chrony_conf_path: "/etc/chrony.conf"
 timesync_ntp_sysconfig_path: /etc/sysconfig/ntpd
 timesync_ptp4l_sysconfig_path: /etc/sysconfig/ptp4l
 timesync_phc2sys_sysconfig_path: /etc/sysconfig/phc2sys
-# wokeignore:rule=master
 timesync_timemaster_config_path: /etc/timemaster.conf