Skip to content

Commit

Permalink
Enabling spellcheck GitHub Action (#3)
Browse files Browse the repository at this point in the history
* Added basic setup and configuration.

* Added spell-check job to job configurations for ci and cd
  • Loading branch information
jonasbn committed Jan 11, 2024
1 parent 82ae096 commit 7132c38
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 13 deletions.
26 changes: 26 additions & 0 deletions .github/config/spellcheck-wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
CocoaPods
Composable
DSL
Github
SPM
ValidatableKit
XCFramework
XCFrameworks
Xcode
automagically
ceacad
faq
gmail
html
https
macOS
mahunt
pre
sexualized
socio
soumya
submodule
tvOS
vscode
watchOS
www
20 changes: 20 additions & 0 deletions .github/config/spellcheck.yaml
Original file line number Diff line number Diff line change
@@ -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
25 changes: 12 additions & 13 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/spellcheck-github-actions@0.24.0
# 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/spellcheck-github-actions@0.35.0
with:
config_path: .github/config/spellcheck.yml

swift-package-test:
name: Swift Package
Expand Down Expand Up @@ -95,7 +94,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

Expand All @@ -111,7 +110,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:
Expand Down

0 comments on commit 7132c38

Please sign in to comment.