ci: Check spelling with codespell (#173)

* 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 <[email protected]>

Author: spetrosi

.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

.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

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

.github/workflows/tft_citest_bad.yml

@@ -1,6 +1,6 @@
 # ssh
 
-[![ansible-centos.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-centos.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-centos.yml) [![ansible-debian.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-debian.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-debian.yml) [![ansible-fedora.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-fedora.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-fedora.yml) [![ansible-lint.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-test.yml) [![ansible-ubuntu.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-ubuntu.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-ubuntu.yml) [![markdownlint.yml](https://github.com/linux-system-roles/ssh/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/markdownlint.yml) [![shellcheck.yml](https://github.com/linux-system-roles/ssh/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/shellcheck.yml) [![tft.yml](https://github.com/linux-system-roles/ssh/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/ssh/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/tft_citest_bad.yml) [![woke.yml](https://github.com/linux-system-roles/ssh/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/woke.yml)
+[![ansible-centos.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-centos.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-centos.yml) [![ansible-debian.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-debian.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-debian.yml) [![ansible-fedora.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-fedora.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-fedora.yml) [![ansible-lint.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-test.yml) [![ansible-ubuntu.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-ubuntu.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-ubuntu.yml) [![codespell.yml](https://github.com/linux-system-roles/ssh/actions/workflows/codespell.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/codespell.yml) [![markdownlint.yml](https://github.com/linux-system-roles/ssh/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/markdownlint.yml) [![shellcheck.yml](https://github.com/linux-system-roles/ssh/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/shellcheck.yml) [![tft.yml](https://github.com/linux-system-roles/ssh/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/ssh/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/tft_citest_bad.yml) [![woke.yml](https://github.com/linux-system-roles/ssh/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/woke.yml)
 
 An Ansible role for managing ssh clients configuration.
 

README.md

@@ -13,7 +13,7 @@ ssh_drop_in_name: "{{ __ssh_drop_in_name }}"
 ssh: []
 
 # list of additional packages to install
-# for exmaple openssh-keycat or openssh-askpass
+# for example openssh-keycat or openssh-askpass
 ssh_additional_packages: []
 
 # the override values for the owner, group and mode of configuration file