Skip to content

Commit

Permalink
WS-6312 Added Spellcheck to Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
karinaMeldere committed Jul 29, 2024
1 parent a673dcd commit df3c472
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/documentation-spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
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: '**/*.md'
task_name: Markdown
output_file: spellcheck-output.txt

- name: Upload spellcheck results
uses: actions/upload-artifact@v3
with:
name: Spellcheck Results
path: spellcheck-output.txt
16 changes: 16 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
matrix:
- name: Markdown
aspell:
lang: en
dictionary:
encoding: utf-8
pipeline:
- pyspelling.filters.markdown:
- pyspelling.filters.html:
comments: false
ignores:
- code
- pre
sources:
- '**/*.md'
default_encoding: utf-8

0 comments on commit df3c472

Please sign in to comment.