Update GitHub Action Confguration (#7)

* Update GitHub Action Confguration - Implement testing on different platforms - Implement typo checking * Update GitHub Action Confguration * Fix typos
space-code · Jan 10, 2024 · 76d95c7 · 76d95c7
1 parent 043a8d9
commit 76d95c7
Show file tree

Hide file tree

Showing 3 changed files with 169 additions and 33 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -8,13 +8,10 @@ on:
   pull_request:
     paths:
       - '.swiftlint.yml'
-    branches:
-      - main
-      - dev
-
-concurrency:
-  group: ci
-  cancel-in-progress: true
+      - ".github/workflows/**"
+      - "Package.swift"
+      - "Source/**"
+      - "Tests/**"
 
 jobs:
   SwiftLint:
@@ -27,39 +24,176 @@ jobs:
           args: --strict
         env:
           DIFF_BASE: ${{ github.base_ref }}
-  Latest:
-    name: Test Latest (iOS, macOS, tvOS, watchOS)
-    runs-on: macOS-12
+  macOS:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.runsOn }}
+    env:
+      DEVELOPER_DIR: "/Applications/${{ matrix.xcode }}.app/Contents/Developer"
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - xcode: "Xcode_15.0"
+            runsOn: macos-13
+            name: "macOS 13, Xcode 15.0, Swift 5.9.0"
+          - xcode: "Xcode_14.3.1"
+            runsOn: macos-13
+            name: "macOS 13, Xcode 14.3.1, Swift 5.8.0"
+    steps:
+      - uses: actions/checkout@v3
+      - name: ${{ matrix.name }}
+        run: xcodebuild test -scheme "Validator-Package" -destination "platform=macOS" clean -enableCodeCoverage YES -resultBundlePath "test_output/${{ matrix.name }}.xcresult" || exit 1
+      - name: Upload coverage reports to Codecov
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          xcode: true
+          xcode_archive_path: test_output/${{ matrix.name }}.xcresult
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.name }}
+          path: test_output
+
+  iOS:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.runsOn }}
+    env:
+      DEVELOPER_DIR: "/Applications/${{ matrix.xcode }}.app/Contents/Developer"
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - destination: "OS=17.0.1,name=iPhone 14 Pro"
+            name: "iOS 17.0.1"
+            xcode: "Xcode_15.0"
+            runsOn: macos-13
+          - destination: "OS=16.4,name=iPhone 14 Pro"
+            name: "iOS 16.4"
+            xcode: "Xcode_14.3.1"
+            runsOn: macos-13
+    steps:
+      - uses: actions/checkout@v3
+      - name: ${{ matrix.name }}
+        run: xcodebuild test -scheme "Validator-Package" -destination "${{ matrix.destination }}" clean -enableCodeCoverage YES -resultBundlePath "test_output/${{ matrix.name }}.xcresult" || exit 1
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.name }}
+          path: test_output
+
+  tvOS:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.runsOn }}
     env:
-      DEVELOPER_DIR: "/Applications/Xcode_14.1.app/Contents/Developer"
-    timeout-minutes: 10
+      DEVELOPER_DIR: "/Applications/${{ matrix.xcode }}.app/Contents/Developer"
+    timeout-minutes: 20
     strategy:
       fail-fast: false
       matrix:
         include:
-          - destination: "OS=16.1,name=iPhone 14 Pro"
-            name: "iOS"
-            scheme: "Validator-Package"
-            sdk: iphonesimulator
-          - destination: "OS=16.1,name=Apple TV"
-            name: "tvOS"
-            scheme: "Validator-Package"
-            sdk: appletvsimulator
-          - destination: "OS=9.1,name=Apple Watch Series 8 (45mm)"
-            name: "watchOS"
-            scheme: "Validator-Package"
-            sdk: watchsimulator
-          - destination: "platform=macOS"
-            name: "macOS"
-            scheme: "Validator-Package"
-            sdk: macosx
+          - destination: "OS=17.0,name=Apple TV"
+            name: "tvOS 17.0"
+            xcode: "Xcode_15.0"
+            runsOn: macos-13
+          - destination: "OS=16.4,name=Apple TV"
+            name: "tvOS 16.4"
+            xcode: "Xcode_14.3.1"
+            runsOn: macos-13
     steps:
       - uses: actions/checkout@v3
       - name: ${{ matrix.name }}
-        run: xcodebuild test -scheme "${{ matrix.scheme }}" -destination "${{ matrix.destination }}" clean -enableCodeCoverage YES -resultBundlePath "./${{ matrix.sdk }}.xcresult" | xcpretty -r junit
+        run: xcodebuild test -scheme "Validator-Package" -destination "${{ matrix.destination }}" clean -enableCodeCoverage YES -resultBundlePath "test_output/${{ matrix.name }}.xcresult" || exit 1
       - name: Upload coverage reports to Codecov
         uses: codecov/[email protected]
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           xcode: true
-          xcode_archive_path: "./${{ matrix.sdk }}.xcresult"
+          xcode_archive_path: test_output/${{ matrix.name }}.xcresult
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.name }}
+          path: test_output
+
+  watchOS:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.runsOn }}
+    env:
+      DEVELOPER_DIR: "/Applications/${{ matrix.xcode }}.app/Contents/Developer"
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - destination: "OS=10.0,name=Apple Watch Series 9 (45mm)"
+            name: "watchOS 10.0"
+            xcode: "Xcode_15.0"
+            runsOn: macos-13
+          - destination: "OS=9.4,name=Apple Watch Series 8 (45mm)"
+            name: "watchOS 9.4"
+            xcode: "Xcode_14.3.1"
+            runsOn: macos-13
+    steps:
+      - uses: actions/checkout@v3
+      - name: ${{ matrix.name }}
+        run: xcodebuild test -scheme "Validator-Package" -destination "${{ matrix.destination }}" clean -enableCodeCoverage YES -resultBundlePath "test_output/${{ matrix.name }}.xcresult" || exit 1
+      - name: Upload coverage reports to Codecov
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          xcode: true
+          xcode_archive_path: test_output/${{ matrix.name }}.xcresult
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.name }}
+          path: test_output
+
+  spm:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.runsOn }}
+    env:
+      DEVELOPER_DIR: "/Applications/${{ matrix.xcode }}.app/Contents/Developer"
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: "Xcode 15"
+            xcode: "Xcode_15.0"
+            runsOn: macos-13
+          - name: "Xcode 14"
+            xcode: "Xcode_14.3.1"
+            runsOn: macos-13
+    steps:
+      - uses: actions/checkout@v3
+      - name: ${{ matrix.name }}
+        run: swift build -c release
+
+  merge-test-reports:
+    needs: [iOS, macOS, watchOS, tvOS]
+    runs-on: macos-13
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: test_output
+      - run: xcrun xcresulttool merge test_output/**/*.xcresult --output-path test_output/final/final.xcresult
+      - name: Upload Merged Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: MergedResult
+          path: test_output/final
+
+  discover-typos:
+    name: Discover Typos
+    runs-on: macOS-12
+    env:
+      DEVELOPER_DIR: /Applications/Xcode_14.1.app/Contents/Developer
+    steps:
+      - uses: actions/checkout@v2
+      - name: Discover typos
+        run: |
+          export PATH="$PATH:/Library/Frameworks/Python.framework/Versions/3.11/bin"
+          python3 -m pip install --upgrade pip
+          python3 -m pip install codespell
+          codespell --ignore-words-list="hart,inout,msdos,sur" --skip="./.build/*,./.git/*"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
+-  Update GitHub Action Configuration
+  - Added in Pull Request [#7](https://github.com/space-code/validator/pull/7).
 - Add `Swift Compatibility` & `Platform Compatibility` badges
   - Added in Pull Request [#6](https://github.com/space-code/validator/pull/6).
 

diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 <h1 align="center" style="margin-top: 0px;">validator</h1>
 
 <p align="center">
-<a href="https://github.com/space-code/validator/blob/main/LICENSE"><img alt="Liscence" src="https://img.shields.io/cocoapods/l/service-core.svg?style=flat"></a> 
+<a href="https://github.com/space-code/validator/blob/main/LICENSE"><img alt="Licence" src="https://img.shields.io/cocoapods/l/service-core.svg?style=flat"></a> 
 <a href="https://swiftpackageindex.com/space-code/validator"><img alt="Swift Compatibility" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fspace-code%2Fvalidator%2Fbadge%3Ftype%3Dswift-versions"/></a> 
 <a href="https://swiftpackageindex.com/space-code/validator"><img alt="Platform Compatibility" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fspace-code%2Fvalidator%2Fbadge%3Ftype%3Dplatforms"/></a> 
 <a href="https://github.com/space-code/validator"><img alt="CI" src="https://github.com/space-code/validator/actions/workflows/ci.yml/badge.svg?branch=main"></a>
@@ -69,7 +69,7 @@ class ViewController: UIViewController {
         textField.add(rule: LengthValidationRule(max: 10, error: "error text"))
         /// Enables automatic validation on input change.
         textField.validateOnInputChange(isEnabled: true)
-        /// Handels validation result.
+        /// Handle the validation result.
         textField.validationHandler = { result in
             switch result {
             case .valid:
@@ -182,7 +182,7 @@ struct ContentView: View {
                 if value {
                     print("The form's fields are valid")
                 } else {
-                    print("The form's fileds aren't valid")
+                    print("The form's fields aren't valid")
                 }
             }
         )