Enabling spellcheck GitHub Action (#9)

* Added basic setup and configuration.

* Added spell-check job to job configurations for ci and cd

Author: jonasbn

.github/config/spellcheck-wordlist.txt

@@ -0,0 +1,41 @@
+CocoaPods
+Codable
+CodingKey
+DocC
+DocumentationExtension
+DynamicCodableKit
+Github
+JSON
+SPM
+Submodule
+XCFramework
+Xcode
+ae
+automagically
+ba
+bab
+casted
+ceb
+eb
+faq
+fc
+fd
+fe
+gmail
+html
+https
+lossy
+macOS
+mahunt
+mergeBehavior
+podspec
+pre
+prebuilt
+sexualized
+socio
+soumya
+submodule
+tvOS
+vscode
+watchOS
+www

.github/config/spellcheck.yaml

@@ -0,0 +1,20 @@
+matrix:
+- name: Markdown
+  aspell:
+    lang: en
+  dictionary:
+    wordlists:
+    - .github/config/spellcheck-wordlist.txt
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - pymdownx.superfences:
+  - pyspelling.filters.html:
+      comments: false
+      ignores:
+      - code
+      - pre
+  sources:
+  - '**/*.md'
+  default_encoding: utf-8

.github/workflows/main.yml

@@ -32,17 +32,16 @@ jobs:
   #     contents: read
   #     security-events: write
 
-  # spell-check:
-  #   name: Run spell check
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #   - name: Checkout repository
-  #     uses: actions/checkout@v3
-
-  #   - name: Spellcheck Action
-  #     uses: rojopolis/[email protected]
-  #     with:
-  #       config_path: .github/config/spellcheck.yml
+  spell-check:
+    name: Run spell check
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+    - name: Spellcheck Action
+      uses: rojopolis/[email protected]
+      with:
+        config_path: .github/config/spellcheck.yml
 
   swift-package-test:
     name: Swift Package
@@ -90,7 +89,7 @@ jobs:
   ci:
     name: CI
     if: github.event_name == 'push'
-    needs: [swift-package-test, xcode-test, cocoapods-test]
+    needs: [swift-package-test, xcode-test, cocoapods-test, spell-check]
     # needs: [analyze, swift-package-test, xcode-test, cocoapods-test]
     uses: SwiftyLab/ci/.github/workflows/ci.yml@main
 
@@ -106,7 +105,7 @@ jobs:
        needs.cocoapods-test.result == 'success' &&
        (needs.ci.result == 'success' || needs.ci.result == 'skipped'))
     # (needs.analyze.result == 'success' || needs.analyze.result == 'skipped')
-    needs: [ci, swift-package-test, xcode-test, cocoapods-test]
+    needs: [ci, swift-package-test, xcode-test, cocoapods-test, spell-check]
     # needs: [ci, analyze, swift-package-test, xcode-test, cocoapods-test]
     uses: SwiftyLab/ci/.github/workflows/cd.yml@main
     with: