diff --git a/.codespell_ignores b/.codespell_ignores new file mode 100644 index 00000000..e69de29b diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 00000000..8f96f52a --- /dev/null +++ b/.codespellrc @@ -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 --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 00000000..8eadb612 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -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 --git a/.github/workflows/tft_citest_bad.yml b/.github/workflows/tft_citest_bad.yml index 85db1f44..9f48f353 100644 --- a/.github/workflows/tft_citest_bad.yml +++ b/.github/workflows/tft_citest_bad.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 --git a/README.md b/README.md index 1dbe660b..16c89d3a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # logging -[![ansible-lint.yml](https://github.com/linux-system-roles/logging/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/logging/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/ansible-test.yml) [![markdownlint.yml](https://github.com/linux-system-roles/logging/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/markdownlint.yml) [![tft.yml](https://github.com/linux-system-roles/logging/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/logging/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/tft_citest_bad.yml) [![woke.yml](https://github.com/linux-system-roles/logging/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/woke.yml) +[![ansible-lint.yml](https://github.com/linux-system-roles/logging/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/logging/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/ansible-test.yml) [![codespell.yml](https://github.com/linux-system-roles/logging/actions/workflows/codespell.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/codespell.yml) [![markdownlint.yml](https://github.com/linux-system-roles/logging/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/markdownlint.yml) [![tft.yml](https://github.com/linux-system-roles/logging/actions/workflows/tft.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/tft.yml) [![tft_citest_bad.yml](https://github.com/linux-system-roles/logging/actions/workflows/tft_citest_bad.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/tft_citest_bad.yml) [![woke.yml](https://github.com/linux-system-roles/logging/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/logging/actions/workflows/woke.yml) ## Background @@ -262,7 +262,7 @@ logging_outputs: #### logging_outputs general queue parameters -* `queue`: A dict containing general queue paramters that can be used by all output module types, see the official rsyslog documentation for full list of parameters and their function. +* `queue`: A dict containing general queue parameters that can be used by all output module types, see the official rsyslog documentation for full list of parameters and their function. ```yaml logging_outputs: @@ -274,7 +274,7 @@ logging_outputs: #### logging_outputs general action parameters -* `action`: A dict containing general action paramters, see the official rsyslog documentation for full list of parameters and their function. +* `action`: A dict containing general action parameters, see the official rsyslog documentation for full list of parameters and their function. ```yaml logging_outputs: diff --git a/roles/rsyslog/tasks/deploy_nolog.yml b/roles/rsyslog/tasks/deploy_nolog.yml index b3aaa240..bf2f21e8 100644 --- a/roles/rsyslog/tasks/deploy_nolog.yml +++ b/roles/rsyslog/tasks/deploy_nolog.yml @@ -3,7 +3,7 @@ # If the input/output has a possibility to reveal some sensitive data, # include this deploy_nolog.yml file. -# See tasks/outputs/elasticsearch/main.yml for an examle. +# See tasks/outputs/elasticsearch/main.yml for an example. - name: Install/Update required packages package: