diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000000..f7b832e56f --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,29 @@ +name: Documentation Checks + +on: + push: + branches: + - dev + paths: + # This ensures the check will only be run when something changes in the docs content + - "docs/en/**/*" # or whatever the path to the markdown / docs files happens to be + pull_request: + branches: + - dev + paths: + - "docs/en/**/*" +jobs: + spellcheck: + name: "Docs: Spellcheck (En)" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + name: Check out the code + - uses: actions/setup-node@v1 + name: Setup node + with: + node-version: "16" + - run: npm install -g cspell + name: Install cSpell + - run: cspell --config ./cSpell.json "docs/en/**/*.md" --no-progress # Update for path to the markdown files + name: Run cSpell