Merge pull request #408 from stevenzeck/swiftui

Author: mickael-menu

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,85 @@
+name: Bug report
+description: File a bug report to help improve the Readium toolkit
+title: "[Bug] "
+labels: ["bug", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for filing a bug report! Please [search for existing issues](https://github.com/readium/swift-toolkit/issues?q=is:issue) before submitting.
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the bug
+      description: Also, please let us know what your expectations were.
+      placeholder: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: bug-steps
+    attributes:
+      label: How to reproduce?
+      description: |
+        Step by step explanation to reproduce the issue in the Test App.
+
+        If you can, drag and drop:
+        - the publication used to reproduce the problem, after zipping it.
+        - screenshots or a screencast showing the issue
+
+      placeholder: |
+        1. Open book X
+        2. Go to chapter Y
+        3. Swipe left twice
+        4. See error
+        ...
+    validations:
+      required: true
+  - type: input
+    id: bug-readium-version
+    attributes:
+      label: Readium version
+      description: What version of the Readium toolkit are you running?
+    validations:
+      required: true
+  - type: input
+    id: bug-os-version
+    attributes:
+      label: OS version
+      description: On which OS version(s) did you reproduce the problem?
+      placeholder: iOS 17.0.1
+    validations:
+      required: true
+  - type: input
+    id: bug-device
+    attributes:
+      label: Testing device
+      description: On which Apple device did you reproduce the problem?
+      placeholder: iPhone 15 Pro Max (emulator)
+    validations:
+      required: true
+  - type: textarea
+    id: bug-environment
+    attributes:
+      label: Environment
+      description: |
+        Run the following shell commands and paste the result here:
+        ```shell
+        echo "macOS: `sw_vers -productVersion`"
+        echo "platform: `uname -m`"
+        echo "carthage: `carthage version`"
+        xcodebuild -version
+        ```
+      placeholder: |
+        macOS: 14.1.2
+        platform: arm64
+        carthage: 0.39.1
+        Xcode 15.1
+        Build version 15C65
+      render: bash
+  - type: textarea
+    id: bug-additional
+    attributes:
+      label: Additional context
+      description: |
+        Share additional code showing how you use Readium, if relevant. Output logs are useful as well.
+        If you already went through the codebase to find the bug, you can explain your findings here.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/config.yml

@@ -13,125 +13,165 @@ env:
 jobs:
   build:
     name: Build
-    runs-on: macos-latest
+    runs-on: macos-12
+    if: ${{ !github.event.pull_request.draft }}
     env:
       scheme: ${{ 'Readium-Package' }}
-      DEVELOPER_DIR: /Applications/Xcode_12.4.app/Contents/Developer
+      DEVELOPER_DIR: /Applications/Xcode_13.4.1.app/Contents/Developer
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Install dependencies
-        run: brew install xcodegen
+        run: |
+          brew update
+          brew install xcodegen
       - name: Check Carthage project
         run: |
           # Check that the Carthage project is up to date.
           make carthage-project
-          git diff --exit-code --name-only Support/Carthage/Readium.xcodeproj
+          git diff --exit-code Support/Carthage/Readium.xcodeproj
       - name: Build
         run: |
-          xcodebuild build-for-testing -scheme "$scheme" -destination "platform=$platform,name=$device"
+          set -eo pipefail
+          xcodebuild build-for-testing -scheme "$scheme" -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
       - name: Test
         run: |
-          xcodebuild test-without-building -scheme "$scheme" -destination "platform=$platform,name=$device"
+          set -eo pipefail
+          xcodebuild test-without-building -scheme "$scheme" -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
 
   lint:
     name: Lint
-    runs-on: macos-latest
+    runs-on: macos-12
+    if: ${{ !github.event.pull_request.draft }}
     env:
       scripts: ${{ 'Sources/Navigator/EPUB/Scripts' }}
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          package_json_file: Sources/Navigator/EPUB/Scripts/package.json
+          run_install: false
+      - name: Setup cache
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: 'pnpm'
+          cache-dependency-path: Sources/Navigator/EPUB/Scripts/pnpm-lock.yaml
       - name: Install dependencies
-        run: yarn --cwd "$scripts" install --frozen-lockfile
-      - name: Lint JavaScript
-        run: yarn --cwd "$scripts" run lint
-      - name: Check JavaScript formatting
-        run: yarn --cwd "$scripts" run checkformat
+        run: pnpm --dir "$scripts" install --frozen-lockfile
+      - name: Lint
+        run: pnpm --dir "$scripts" run lint
+      - name: Check formatting
+        run: pnpm --dir "$scripts" run checkformat
       - name: Check if bundled scripts are up-to-date
         run: |
             make scripts
             git diff --exit-code --name-only Sources/Navigator/EPUB/Assets/Static/scripts/*.js
+      - name: Lint Swift formatting
+        run: make lint-format
 
   int-dev:
     name: Integration (Local)
-    runs-on: macos-latest
+    runs-on: macos-12
+    if: ${{ !github.event.pull_request.draft }}
     defaults:
       run:
         working-directory: TestApp
     environment: LCP
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Install dependencies
-        run: brew install xcodegen
+        run: |
+          brew update
+          brew install xcodegen
       - name: Generate project
         run: make dev lcp=${{ secrets.LCP_URL_SPM }}
       - name: Build
         run: |
-          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device"
-
-  # The following integration jobs are run only when pushing to `develop` or `main`.
-  # As they use a specific commit hash, they can't run properly from a pull request
-  # opened from forks.
+          set -eo pipefail
+          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
 
   int-spm:
     name: Integration (Swift Package Manager)
-    if: github.event_name == 'push'
-    runs-on: macos-latest
+    runs-on: macos-12
+    if: ${{ !github.event.pull_request.draft }}
     defaults:
       run:
         working-directory: TestApp
     environment: LCP
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+      # We can't use the current github.sha with pull_request event, because they will
+      # reference the merge commit which cannot be fetched with SPM.
+      - name: Set commit SHA
+        if: github.event_name == 'pull_request'
+        run: |
+          echo "commit_sha=${{ github.event.pull_request.head.sha }}" >> "$GITHUB_ENV"
       - name: Install dependencies
-        run: brew install xcodegen
+        run: |
+          brew update
+          brew install xcodegen
       - name: Generate project
         run: make spm lcp=${{ secrets.LCP_URL_SPM }} commit=$commit_sha
       - name: Build
         run: |
-          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device"
+          set -eo pipefail
+          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
 
   int-carthage:
     name: Integration (Carthage)
-    if: github.event_name == 'push'
-    runs-on: macos-latest
+    runs-on: macos-12
+    if: ${{ !github.event.pull_request.draft }}
     defaults:
       run:
         working-directory: TestApp
     environment: LCP
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+      # We can't use the current github.sha with pull_request event, because they will
+      # reference the merge commit which cannot be fetched with Carthage.
+      - name: Set commit SHA
+        if: github.event_name == 'pull_request'
+        run: |
+          echo "commit_sha=${{ github.event.pull_request.head.sha }}" >> "$GITHUB_ENV"
       - name: Install dependencies
-        run: brew install xcodegen
+        run: |
+          brew update
+          brew install xcodegen
       - name: Generate project
         run: make carthage lcp=${{ secrets.LCP_URL_CARTHAGE }} commit=$commit_sha
       - name: Build
         run: |
-          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device"
+          set -eo pipefail
+          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
 
   # Warning: This job cannot actually test the state of the current commit,
   # but will check that the latest branch/tag set in the Podspecs are valid.
   int-cocoapods:
     name: Integration (CocoaPods)
     if: github.event_name == 'push'
-    runs-on: macos-latest
+    runs-on: macos-12
     defaults:
       run:
         working-directory: TestApp
     environment: LCP
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Install dependencies
-        run: brew install xcodegen
+        run: |
+          brew update
+          brew install xcodegen
       - name: Generate project
         run: make cocoapods lcp=${{ secrets.LCP_URL_COCOAPODS }} commit=$commit_sha
       - name: Build
         run: |
-          xcodebuild build -workspace TestApp.xcworkspace -scheme TestApp -destination "platform=$platform,name=$device"
+          set -eo pipefail
+          xcodebuild build -workspace TestApp.xcworkspace -scheme TestApp -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi

.github/workflows/checks.yml

@@ -4,7 +4,7 @@
 # Swift Package Manager
 .build/
 .swiftpm/
-Package.resolved
+./Package.resolved
 
 # Carthage
 ./Carthage/

.gitignore

@@ -0,0 +1,4 @@
+--swiftversion 5.6
+--exclude Carthage
+--header "//\n//  Copyright {year} Readium Foundation. All rights reserved.\n//  Use of this source code is governed by the BSD-style license\n//  available in the top-level LICENSE file of the project.\n//"
+--stripunusedargs closure-only

.swiftformat

@@ -0,0 +1,5 @@
+//
+//  Copyright 2024 Readium Foundation. All rights reserved.
+//  Use of this source code is governed by the BSD-style license
+//  available in the top-level LICENSE file of the project.
+//