From 31cf74335f72c927a18fabdb463eaee7804cefd8 Mon Sep 17 00:00:00 2001 From: CJ42 Date: Fri, 7 Jul 2023 16:15:36 +0100 Subject: [PATCH] add spell check in CI on PR --- .github/workflows/spellcheck.yml | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/workflows/spellcheck.yml diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000000..3dffd9b5f4 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,29 @@ +# This workflow checks for common grammar and spelling mistake in markdown docs files. +name: Spellcheck +on: workflow_dispatch + +jobs: + build: + name: Spellcheck + runs-on: ubuntu-latest + steps: + - name: Checkout 🛎️ + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Install ⚙️ + run: yarn install --frozen-lockfile + + - name: Spellcheck 📝 + uses: rojopolis/spellcheck-github-actions@0.33.0 + with: + source_files: docs/**/*.md docs/**/*.mdx + task_name: Markdown + output_file: spellcheck-output.txt + + - name: Output Spellcheck Results 📝 + uses: actions/upload-artifact@v3 + with: + name: Spellcheck Output + path: spellcheck-output.txt