Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enabling spellcheck GitHub Action #3

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Enabling spellcheck GitHub Action #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0eb2c73
Added basic setup and configuration. Corrected a few spelling mistakes
jonasbn Nov 21, 2023
f04a677
Added spell-check job to job configurations for ci and cd
jonasbn Nov 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/config/spellcheck-wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
CocoaPods
Github
JSON
SPM
TabNavigator
Xcode
deterministically
faq
gmail
html
https
json
macOS
mahunt
sexualized
socio
soumya
tvOS
uptime
vscode
watchOS
www
20 changes: 20 additions & 0 deletions .github/config/spellcheck.yaml
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,16 @@ jobs:
]
}

# 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
Expand Down Expand Up @@ -85,7 +84,7 @@ jobs:
ci:
name: CI
if: github.event_name == 'push'
needs: [analyze, swift-package-test]
needs: [analyze, swift-package-test, spell-check]
uses: SwiftyLab/ci/.github/workflows/ci.yml@main

cd:
Expand All @@ -98,7 +97,7 @@ jobs:
(needs.ci.result == 'success' || needs.ci.result == 'skipped') &&
(needs.analyze.result == 'success' || needs.analyze.result == 'skipped') &&
(needs.swift-package-test.result == 'success' || needs.swift-package-test.result == 'skipped'))
needs: [analyze, swift-package-test, ci]
needs: [analyze, swift-package-test, ci, spell-check]
uses: SwiftyLab/ci/.github/workflows/cd.yml@main
with:
version: ${{ github.event.inputs.version }}
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A no-boilerplate dependency management library for Swift.

When following [Single responsibility](https://en.wikipedia.org/wiki/Single-responsibility_principle) in [SOLID](https://en.wikipedia.org/wiki/SOLID) principle, code is divided into multiple types/functions each representing a responsibility/goal, i.e. storage access, database and networking, scheduling etc.

These types/functions can depend on each other and it is important these dependences need to be controlled to deterministically test each responsibility, free from side effects from external components, i.e. file systems, network connectivity and speed, server uptime etc.
These types/functions can depend on each other and it is important these dependencies need to be controlled to deterministically test each responsibility, free from side effects from external components, i.e. file systems, network connectivity and speed, server uptime etc.

This library addresses this concern by allowing controlling dependencies with following features:

Expand Down
2 changes: 1 addition & 1 deletion Sources/Contexts/Contexts.docc/Contexts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A no-boilerplate dependency management library for Swift.

When following [Single responsibility](https://en.wikipedia.org/wiki/Single-responsibility_principle) in [SOLID](https://en.wikipedia.org/wiki/SOLID) principle, code is divided into multiple types/functions each representing a responsibility/goal, i.e. storage access, database and networking, scheduling etc.

These types/functions can depend on each other and it is important these dependences need to be controlled to deterministically test each responsibility, free from side effects from external components, i.e. file systems, network connectivity and speed, server uptime etc.
These types/functions can depend on each other and it is important these dependencies need to be controlled to deterministically test each responsibility, free from side effects from external components, i.e. file systems, network connectivity and speed, server uptime etc.

This library addresses this concern by allowing controlling dependencies with following features:

Expand Down