From fddc18962a24cf2e17edac7302b080ed73e5ce06 Mon Sep 17 00:00:00 2001 From: Karina Meldere Date: Mon, 29 Jul 2024 08:08:36 +0300 Subject: [PATCH] WS-6312 Added Spellcheck to Documentation --- .../workflows/documentation-spellcheck.yml | 23 +++++++++++++++++++ .github/workflows/spellcheck.yml | 15 ++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 .github/workflows/documentation-spellcheck.yml create mode 100644 .github/workflows/spellcheck.yml diff --git a/.github/workflows/documentation-spellcheck.yml b/.github/workflows/documentation-spellcheck.yml new file mode 100644 index 0000000..4803023 --- /dev/null +++ b/.github/workflows/documentation-spellcheck.yml @@ -0,0 +1,23 @@ +name: Documentation Spellcheck + +on: [push] + +jobs: + spellcheck: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Run Spellcheck + uses: rojopolis/spellcheck-github-actions@0.40.0 + with: + config_path: ".github/workflows/spellcheck.yml" + source_files: "docs/Selectors.md" + task_name: Markdown + + - name: Upload spellcheck results + uses: actions/upload-artifact@v3 + with: + name: Spellcheck Results + path: spellcheck-output.txt diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000..49a0125 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,15 @@ +matrix: + - name: Markdown + aspell: + lang: en + dictionary: + encoding: utf-8 + pipeline: + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre + sources: + - "docs/*.md" + default_encoding: utf-8