DTSERWONE-887 - Generate documentation (#136)

* DTSERWONE-887 - Generate documentation

* DTSERWONE-887 - Fix the doc target folders

* DTSERWONE-887 - Script to push the documentation

* DTSERWONE-887 - Publish doc on GitHub Pages

* DTSERWONE-887 - Update Hippolyte lib

Author: grmeyer-hw-dev

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Core SDK CI
+name: iOS Core SDK CI
 
 on:
   workflow_dispatch:
@@ -8,23 +8,18 @@ on:
       - support/SDK-V3
       - feature/**
       - bugfix/**
-  pull_request:
-    branches:
-      - master
-      - support/SDK-V3
-      - feature/**
-      - bugfix/**
 
 jobs:
-  tests:
-    name: Tests
+  test:
+    name: Test - ${{ matrix.os }} - ${{ matrix.xcode_version }} - ${{ matrix.fastlane_task }}
     strategy:
       fail-fast: false
       matrix:
         include:
           - os: macos-12
             xcode_version: 13.4
             fastlane_task: unit_tests
+
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
@@ -58,7 +53,8 @@ jobs:
 
       - name: Code Coverage [Build report]
         run: |
-          export PATH="/usr/local/opt/llvm/bin:$PATH"
+          brew install llvm
+          export PATH="$(brew --prefix llvm)/bin:$PATH"
           llvm-cov report \
           --use-color \
           --instr-profile=$(find ./output -name "*.profdata") \
@@ -67,7 +63,7 @@ jobs:
 
       - name: Code Coverage [Export report to lcov format]
         run: |
-          export PATH="/usr/local/opt/llvm/bin:$PATH"
+          export PATH="$(brew --prefix llvm)/bin:$PATH"
           mkdir coverage
           llvm-cov export \
           --format=lcov > ./coverage/lcov.info \

.github/workflows/documentation.yml

@@ -0,0 +1,35 @@
+name: Update Documentation
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+
+jobs:
+  documentation:
+    name: Documentation
+    strategy:
+      matrix:
+        include:
+          - os: macos-12
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Generate documentation
+        run: |
+          jazzy \
+            --min-acl public \
+            --no-hide-documentation-coverage \
+            --theme fullwidth \
+            --title HyperwalletSDK \
+            --module HyperwalletSDK \
+            --output ./docs \
+            --documentation=./*.md
+
+      - name: Publish on GitHub Pages
+        uses: ftnext/[email protected]
+        with:
+          build_dir: docs
+          github_token: ${{ secrets.GITHUB_TOKEN }}

Cartfile.private

@@ -1 +1 @@
-github "JanGorman/Hippolyte" "0.6.0"
+github "JanGorman/Hippolyte" "1.4.1"

Makefile

@@ -93,7 +93,7 @@ class HyperwalletPrepaidCardBalanceTests: XCTestCase {
             XCTAssertNil(prepaidCardBalanceList, "The `prepaidCardBalanceList` should be nil")
         }
     }
-    
+
     override static var defaultTestSuite: XCTestSuite {
         let testSuite = XCTestSuite(name: String(describing: self))
         let testParameters = getTestParameters()