From 0eb2c73d6a9c296f7487413e7a8dcd5789f961ae Mon Sep 17 00:00:00 2001 From: jonasbn Date: Tue, 21 Nov 2023 17:57:01 +0100 Subject: [PATCH 1/2] Added basic setup and configuration. Corrected a few spelling mistakes --- .github/config/spellcheck-wordlist.txt | 22 ++++++++++++++++++++++ .github/config/spellcheck.yaml | 20 ++++++++++++++++++++ .github/workflows/main.yml | 21 ++++++++++----------- README.md | 2 +- Sources/Contexts/Contexts.docc/Contexts.md | 2 +- 5 files changed, 54 insertions(+), 13 deletions(-) create mode 100644 .github/config/spellcheck-wordlist.txt create mode 100644 .github/config/spellcheck.yaml diff --git a/.github/config/spellcheck-wordlist.txt b/.github/config/spellcheck-wordlist.txt new file mode 100644 index 0000000..64b2da8 --- /dev/null +++ b/.github/config/spellcheck-wordlist.txt @@ -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 diff --git a/.github/config/spellcheck.yaml b/.github/config/spellcheck.yaml new file mode 100644 index 0000000..e16f84f --- /dev/null +++ b/.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 diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index fcfcd20..d8cf7ed 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -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/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 diff --git a/README.md b/README.md index a461312..a468829 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/Sources/Contexts/Contexts.docc/Contexts.md b/Sources/Contexts/Contexts.docc/Contexts.md index e09ad7e..1da5226 100644 --- a/Sources/Contexts/Contexts.docc/Contexts.md +++ b/Sources/Contexts/Contexts.docc/Contexts.md @@ -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: From f04a67726f9e75e4c31a980df80f516ca9f97b00 Mon Sep 17 00:00:00 2001 From: jonasbn Date: Thu, 23 Nov 2023 12:28:22 +0100 Subject: [PATCH 2/2] Added spell-check job to job configurations for ci and cd --- .github/workflows/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d8cf7ed..690249a 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -84,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: @@ -97,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 }}