Release Candidate 3.0.0 (#22)

Release Candidate `3.0.0`
space-code · Feb 12, 2024 · e510a4c · e510a4c
2 parents 22b569a + a120b99
commit e510a4c
Show file tree

Hide file tree

Showing 182 changed files with 8,577 additions and 959 deletions.
diff --git a/...ub/PULL_REQUEST_TEMPLATE/bug_template.yml → ...hub/PULL_REQUEST_TEMPLATE/bug_template.md b/...ub/PULL_REQUEST_TEMPLATE/bug_template.yml → ...hub/PULL_REQUEST_TEMPLATE/bug_template.md
diff --git a/...ULL_REQUEST_TEMPLATE/feature_template.yml → ...PULL_REQUEST_TEMPLATE/feature_template.md b/...ULL_REQUEST_TEMPLATE/feature_template.yml → ...PULL_REQUEST_TEMPLATE/feature_template.md
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,216 @@ 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"
+          - xcode: "Xcode_14.2"
+            runsOn: macOS-12
+            name: "macOS 12, Xcode 14.2, Swift 5.7.2"
+          - xcode: "Xcode_14.1"
+            runsOn: macOS-12
+            name: "macOS 12, Xcode 14.1, Swift 5.7.1"
+    steps:
+      - uses: actions/checkout@v3
+      - name: ${{ matrix.name }}
+        run: xcodebuild test -scheme "Flare" -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: Install Dependencies
+        run: make setup_build_tools
+      - name: Generate project
+        run: make generate
+      - name: ${{ matrix.name }}
+        run: xcodebuild test -scheme "Flare" -destination "${{ matrix.destination }}" -testPlan AllTests 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/${{ matrix.xcode }}.app/Contents/Developer"
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - 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: Install Dependencies
+        run: make setup_build_tools
+      - name: Generate project
+        run: make generate
+      - name: ${{ matrix.name }}
+        run: xcodebuild test -scheme "Flare" -destination "${{ matrix.destination }}" -testPlan AllTests 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
+
+  watchOS:
+    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: "Flare"
-            sdk: iphonesimulator
-          - destination: "OS=16.1,name=Apple TV"
-            name: "tvOS"
-            scheme: "Flare"
-            sdk: appletvsimulator
-          - destination: "OS=9.1,name=Apple Watch Series 8 (45mm)"
-            name: "watchOS"
-            scheme: "Flare"
-            sdk: watchsimulator
-          - destination: "platform=macOS"
-            name: "macOS"
-            scheme: "Flare"
-            sdk: macosx
+          - 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
+          - destination: "OS=8.5,name=Apple Watch Series 7 (45mm)"
+            name: "watchOS 8.5"
+            xcode: "Xcode_14.3.1"
+            runsOn: macos-13
     steps:
       - uses: actions/checkout@v3
+      - name: Install Dependencies
+        run: make setup_build_tools
+      - name: Generate project
+        run: make generate
       - 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 "Flare" -destination "${{ matrix.destination }}" -testPlan UnitTests 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
+
+  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 --target Flare
+
+  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/*"
+
+  # Beta:
+  #   name: ${{ matrix.name }}
+  #   runs-on: firebreak
+  #   env:
+  #     DEVELOPER_DIR: "/Applications/Xcode_15.0.app/Contents/Developer"
+  #   timeout-minutes: 10
+  #   strategy:
+  #     fail-fast: false
+  #     matrix:
+  #       include:
+  #         - destination: "OS=1.0,name=Apple Vision Pro"
+  #           name: "visionOS 1.0"
+  #           scheme: "Flare"
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - name: ${{ matrix.name }}
+  #       run: xcodebuild test -scheme "${{ matrix.scheme }}" -destination "${{ matrix.destination }}" clean || exit 1
diff --git a/.github/workflows/danger.yml b/.github/workflows/danger.yml
@@ -0,0 +1,29 @@
+name: Danger
+
+on:
+  pull_request:
+    types: [synchronize, opened, reopened, labeled, unlabeled, edited]
+
+env:
+  LC_CTYPE: en_US.UTF-8
+  LANG: en_US.UTF-8
+
+jobs:
+  run-danger:
+    runs-on: ubuntu-latest
+    steps:
+      - name: ruby setup
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.4
+          bundler-cache: true
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup gems
+        run: |
+          gem install bundler
+          bundle install --clean --path vendor/bundle
+      - name: danger
+        env:
+          DANGER_GITHUB_API_TOKEN: ${{ secrets.DANGER_GITHUB_API_TOKEN }}
+        run: bundle exec danger --verbose
diff --git a/.github/workflows/publish-pages.yml b/.github/workflows/publish-pages.yml
@@ -0,0 +1,42 @@
+name: Deploy DocC
+
+on:
+  push:
+    branches: 
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: macos-12
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+      - name: Build DocC
+        run: |
+          swift build;
+          swift package \
+            --allow-writing-to-directory ./docs \
+            generate-documentation \
+            --target Flare \
+            --output-path ./docs \
+            --transform-for-static-hosting \
+            --hosting-base-path flare;
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
diff --git a/.gitignore b/.gitignore
@@ -88,3 +88,4 @@ fastlane/test_output
 # https://github.com/johnno1962/injectionforxcode
 
 iOSInjectionProject/
+*.xcodeproj
diff --git a/.swiftformat b/.swiftformat
@@ -36,8 +36,8 @@
 --enable redundantSelf
 --enable redundantVoidReturnType
 --enable semicolons
---enable sortedImports
---enable sortedSwitchCases
+--enable sortImports
+--enable sortSwitchCases
 --enable spaceAroundBraces
 --enable spaceAroundBrackets
 --enable spaceAroundComments

diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -1,6 +1,9 @@
 excluded:
   - Tests
   - Package.swift
+  - [email protected]
+  - [email protected]
+  - Sources/Flare/Classes/Generated/Strings.swift
   - .build
 
 # Rules
@@ -9,6 +12,7 @@ disabled_rules:
   - trailing_comma
   - todo
   - opening_brace
+  - unneeded_synthesized_initializer
 
 opt_in_rules: # some rules are only opt-in
   - anyobject_protocol
Original file line number	Diff line number	Diff line change
Expand Up		@@ -88,3 +88,4 @@ fastlane/test_output
		# https://github.com/johnno1962/injectionforxcode

		iOSInjectionProject/
		*.xcodeproj