瀏覽代碼

[ci] Add spell check

vacabun 1 年之前
父節點
當前提交
0fd9508ad6
共有 2 個文件被更改,包括 43 次插入0 次删除
  1. 1 0
      .github/actions/spelling/allow.txt
  2. 42 0
      .github/workflows/spell_check.yml

+ 1 - 0
.github/actions/spelling/allow.txt

@@ -0,0 +1 @@
+github

+ 42 - 0
.github/workflows/spell_check.yml

@@ -0,0 +1,42 @@
+name: Check Spelling
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  spelling:
+    name: Check Spelling
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'RT-Thread'
+    permissions:
+      contents: read
+      pull-requests: read
+      actions: read
+    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@v0.0.20
+      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