ci: Check spelling with codespell

* You can ignore words inline by adding a comment like `# codespell:ignore word`.
* You can ignore words by adding them to the `.codespell_ignores` file.
* You can ignore files and directories by adding them with `skip = ` to the `.codespellrc` file.

Signed-off-by: Sergei Petrosian <spetrosi@redhat.com>

Author: spetrosi

Diff for: .codespell_ignores

@@ -0,0 +1,8 @@
+[codespell]
+check-hidden = true
+# Note that `-w` doesn't work when ignore-multiline-regex is set
+# https://github.com/codespell-project/codespell/issues/3642
+ignore-multiline-regex = codespell:ignore-begin.*codespell:ignore-end
+ignore-words = .codespell_ignores
+# skip-file is not available https://github.com/codespell-project/codespell/pull/2759
+skip = .pandoc_template.html5,.README.html

Diff for: .codespellrc

@@ -0,0 +1,17 @@
+# 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: Codespell
+        uses: codespell-project/actions-codespell@v2

Diff for: .github/workflows/codespell.yml

@@ -36,7 +36,7 @@ jobs:
           RUN_ID=$(gh api "repos/$REPO/actions/workflows/tft.yml/runs?event=issue_comment" \
             | jq -r "[.workflow_runs[] | select( .display_title == \"$PR_TITLE\" ) | select( .conclusion == \"failure\" ) | .id][0]")
           if [ "$RUN_ID" = "null" ]; then
-            echo "Failed workflow not found, exitting"
+            echo "Failed workflow not found, exiting"
             exit 1
           fi
           echo "Re-running workflow $RUN_ID"

Diff for: .github/workflows/tft_citest_bad.yml

@@ -39,7 +39,7 @@ variables:
   rules:
     - if: $BASE_IMAGE_NAME !~ /^LsrRhel8.*/
 
-# Linting / code formating that either works the same on all images or using
+# Linting / code formatting that either works the same on all images or using
 # the newest linter / formatter is desired
 # Rhel9 can be dropped once Rhel10 is stable
 .job_generic_linter:

Diff for: .gitlab-ci.yml

@@ -1,6 +1,6 @@
 # ha_cluster
 
-[![ansible-lint.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-test.yml) [![codeql.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/codeql.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/codeql.yml) [![markdownlint.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/markdownlint.yml) [![python-unit-test.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/python-unit-test.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/python-unit-test.yml) [![shellcheck.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/shellcheck.yml) [![tft.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/tft_citest_bad.yml) [![woke.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/woke.yml)
+[![ansible-lint.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-test.yml) [![codeql.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/codeql.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/codeql.yml) [![codespell.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/codespell.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/codespell.yml) [![markdownlint.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/markdownlint.yml) [![python-unit-test.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/python-unit-test.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/python-unit-test.yml) [![shellcheck.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/shellcheck.yml) [![tft.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/tft_citest_bad.yml) [![woke.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/woke.yml)
 
 An Ansible role for managing High Availability Clustering.
 

Diff for: README.md

@@ -110,7 +110,7 @@ def export_cluster_configuration(module: AnsibleModule) -> Dict[str, Any]:
         corosync_enabled, pacemaker_enabled
     )
 
-    # Corosync config is availabe via CLI since pcs-0.10.8, via API v2 since
+    # Corosync config is available via CLI since pcs-0.10.8, via API v2 since
     # pcs-0.12.0 and pcs-0.11.9. For old pcs versions, CLI must be used, and
     # there is no benefit in implementing access via API on top of that.
     # No need to check pcs capabilities. If this is not supported by pcs,

Diff for: library/ha_cluster_info.py

@@ -25,7 +25,7 @@
           | map('length') | unique | length > 1
       run_once: true
 
-    # Running a qnetd on a cluster node does't make sense, fencing would make
+    # Running a qnetd on a cluster node doesn't make sense, fencing would make
     # the qnetd unavailable, even if temporarily.
     - name: Fail if configuring qnetd on a cluster node
       ansible.builtin.fail:

Diff for: tasks/shell_crmsh/check-and-prepare-role-variables.yml

@@ -79,7 +79,7 @@
           | map('length') | unique | length > 1
       run_once: true
 
-    # Running a qnetd on a cluster node does't make sense, fencing would make
+    # Running a qnetd on a cluster node doesn't make sense, fencing would make
     # the qnetd unavailable, even if temporarily.
     - name: Fail if configuring qnetd on a cluster node
       fail:

Diff for: tasks/shell_pcs/check-and-prepare-role-variables.yml

@@ -42,7 +42,7 @@
 
         # Generate an "inventory" variable for each node.
         # Number of SBD devices is the same for all nodes. This is expected to
-        # be overriden with the play variable in the role.
+        # be overridden with the play variable in the role.
         - name: Set SBD devices variable
           set_fact:
             ha_cluster:

Diff for: tests/tests_sbd_check_devices_count_combined.yml

@@ -26,7 +26,7 @@
 
 class Pcs(TestCase):
     cmd_name = "some pcs command"
-    cmd_params = dict(some="option", another=["opti", "ons"])
+    cmd_params = dict(some="option", another=["opti", "owns"])
     cmd_options = CommandOptionsDto(request_timeout=60)
     cmd_dto = CommandDto(cmd_name, cmd_params, cmd_options)