diff --git a/.github/workflows/spell_check.yml b/.github/workflows/spell_check.yml new file mode 100644 index 00000000000..fabc4215b86 --- /dev/null +++ b/.github/workflows/spell_check.yml @@ -0,0 +1,34 @@ +name: Check Spelling + +on: + pull_request: + branches: + - master + paths: + - 'documentation/**' +jobs: + spelling: + name: Check Spelling + runs-on: ubuntu-22.04 + if: github.repository_owner == 'RT-Thread' + steps: + - name: output ignore words info + run: | + echo "> If any words shown as incorrect are spelled correctly, please add them to .github/actions/spelling/allow.txt." >> $GITHUB_STEP_SUMMARY + - name: check spelling + id: spelling + uses: check-spelling/check-spelling@main + with: + checkout: true + check_file_names: 0 + only_check_changed_files: 1 + post_comment: 0 + extra_dictionaries: + cspell:en_US/src/en_US.txt + cspell:software-terms/softwareTerms.txt + cspell:python/python.txt + cspell:cpp/cpp.txt + check_extra_dictionaries: '' + - name: output Success info + run: | + echo "✅ Check spelling success." >> $GITHUB_STEP_SUMMARY