Merge pull request #2593 from suvajit-sarkar/develop #112
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
--- | |
name: spell check | |
on: | |
push: | |
branches: | |
- "**" | |
pull_request: | |
paths: | |
- 'docs/*.md' | |
types: [opened, edited, synchronize, reopened] | |
env: | |
SPELL_CHECK_DISABLED: false | |
jobs: | |
check-spelling: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Set up Python 3.8 | |
uses: actions/setup-python@v2 | |
with: | |
python-version: 3.8 | |
# Install the dependencies for spell check. | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip setuptools | |
python -m pip install pyspelling | |
sudo apt-get install hunspell hunspell-en-us aspell aspell-en | |
- uses: actions/checkout@v2 | |
- name: Spellcheck | |
if: ${{ env.SPELL_CHECK_DISABLED == 'false' }} | |
uses: rojopolis/[email protected] | |
with: | |
config_path: .github/.spellcheck.yaml | |
source_files: 'docs/*.md' # name of the file to check the spell | |
task_name: Markdown |