Merge branch '24-build-xcframework-instead-of-carthage-archive' into 'master'

Resolve "Build xcframework instead of Carthage archive"

Closes #24

See merge request pace/mobile/ios/pace-cloud-sdk!41

Author: patrickniepel

.gitlab-ci.yml

@@ -14,24 +14,17 @@ stages:
   - publish
 
 before_script:
-  - eval $(ssh-agent)
-  - ssh-add -D
   - mkdir -p Carthage/Build && rsync -a ~/CarthageCache-PACECloudSDK/Build/ Carthage/Build > /dev/null 2>&1 || echo "CarthageCache not found"
-  - mkdir -p ~/.ssh
-  - touch ~/.ssh/known_hosts
-  - ssh-keygen -F repo.pacelink.net > /dev/null || ssh-keyscan repo.pacelink.net >> ~/.ssh/known_hosts
-  - ssh-keygen -F docs.pacelink.net > /dev/null || ssh-keyscan docs.pacelink.net >> ~/.ssh/known_hosts
-  - ssh-keygen -F lab.jamit.de > /dev/null || ssh-keyscan lab.jamit.de >> ~/.ssh/known_hosts
-  - ssh-add || true # Add default key to SSH agent (deploy keys)
-  - rm -f tmpfile && echo "$SSH_PRIVATE_KEY_DEPLOYS" >tmpfile && chmod 600 tmpfile && ssh-add tmpfile && rm -f tmpfile
-  - ssh-add -l
+  - carthage bootstrap --platform iOS --no-use-binaries --cache-builds
   - bundle install || true
   - export TAG_COMMIT_TIME=$(git show -s --format=%ct $CI_COMMIT_SHA)
   - echo "Commit time to be used as build number:" $TAG_COMMIT_TIME
   - export BUILD_NUMBER=$(TZ=Etc/Utc date -j -f '%s' ${TAG_COMMIT_TIME} "+%Y%m%d%H")
   - export VERSION_NAME=$(TZ=Etc/Utc date -j -f '%s' ${TAG_COMMIT_TIME} "+%y.%V.%u")
   - echo "Building version $VERSION_NAME with build number $BUILD_NUMBER"
   - export XCODE_XCCONFIG_FILE=$PWD/linkerFix.xcconfig
+  - export TAG_NAME=${CI_COMMIT_TAG:-'2.0.0'}
+  - echo "Current tag version $TAG_NAME"
 
 after_script:
   - mkdir -p ~/CarthageCache-PACECloudSDK/Build && rsync -a Carthage/Build/ ~/CarthageCache-PACECloudSDK/Build > /dev/null 2>&1 || echo "Couldn't copy Carthage"
@@ -86,6 +79,23 @@ after_script:
     refs:
       - merge_requests
 
+.xcframework: &xcframework
+  script:
+    - bundle exec fastlane set_version version_number:$TAG_NAME
+    - xcodebuild archive
+      -scheme $PROJECT_NAME
+      -sdk iphoneos
+      -archivePath "archives/ios_devices.xcarchive" BUILD_LIBRARY_FOR_DISTRIBUTION=YES SKIP_INSTALL=NO
+    - xcodebuild archive
+      -scheme $PROJECT_NAME
+      -sdk iphonesimulator
+      -archivePath "archives/ios_simulators.xcarchive" BUILD_LIBRARY_FOR_DISTRIBUTION=YES SKIP_INSTALL=NO
+    - xcodebuild
+      -create-xcframework
+      -framework archives/ios_devices.xcarchive/Products/Library/Frameworks/$PROJECT_NAME.framework
+      -framework archives/ios_simulators.xcarchive/Products/Library/Frameworks/$PROJECT_NAME.framework
+      -output build/${PROJECT_NAME}_${TAG_NAME}.xcframework
+
 pacecloudsdk_plists:
  extends: .plist
 
@@ -103,23 +113,20 @@ pacecloudsdk_unit_tests:
 framework_review:
   extends: .xcode_version
   stage: build
-  script:
-    - bundle exec fastlane build_framework
+  <<: *xcframework
   only:
-    refs:
-      - merge_requests
+    - merge_requests
 
 framework_release_build:
   extends: .xcode_version
   stage: build
-  script:
-    - bundle exec fastlane build_framework archive:true
+  <<: *xcframework
   only:
     - tags
   artifacts:
     name: $PROJECT_NAME
     paths:
-      - ./PACECloudSDK.framework.zip
+      - ./build/
     expire_in: 1 week
 
 # Documentation

ExampleApp/.gitlab-ci.yml

@@ -118,4 +118,4 @@ pacecloudsdkexample_stop_review:
   extends: .stop_review
   <<: *only_merge_requests
   variables:
-    REPO_PROJECT_ID: "pacecloudsdkexample"
+    REPO_PROJECT_ID: "pacecloudsdkexample"

README.md

@@ -1,8 +1,31 @@
 # PACE Cloud SDK
-This framework combines multipe functionalities provided by PACE i.e. authorizing via **PACE ID** or requesting and displaying **Apps**. These functionalities are separated and structured into different ***Kits*** by namespacing as follows:
 
-- [IDKit](#idkit)
-- [AppKit](#appkit)
+This framework combines multipe functionalities provided by PACE i.e. authorizing via **PACE ID** or requesting and displaying **Apps**. These functionalities are separated and structured into different ***Kits*** by namespaces, i.e. [IDKit](#idkit), [AppKit](#appkit).
+
+- [PACE Cloud SDK](#pace-cloud-sdk)
+    * [Specifications](#specifications)
+    * [Setup](#setup)
+        + [Carthage](#carthage)
+        + [Cocoapods](#cocoapods)
+        + [Swift Package Manager](#swift-package-manager)
+    * [IDKit](#idkit)
+        + [Setup](#setup-1)
+        + [Authorization](#authorization)
+        + [Token refresh](#token-refresh)
+        + [Session refreshToken](#session-refreshtoken)
+    * [AppKit](#appkit)
+        + [Main Features](#main-features)
+        + [Setup](#setup-2)
+        + [Native login](#native-login)
+        + [Deep Linking](#deep-linking)
+        + [AppKitDelegate](#appkitdelegate)
+        + [Requesting local Apps](#requesting-local-apps)
+        + [Is POI in range?](#is-poi-in-range-)
+        + [AppWebView / AppViewController](#appwebview---appviewcontroller)
+        + [AppDrawerContainer](#appdrawercontainer)
+        + [AppDrawer](#appdrawer)
+        + [AppError](#apperror)
+    * [FAQ](#faq)
 
 ## Specifications
 **PACECloudSDK** currently supports iOS 11 and above.
@@ -100,6 +123,8 @@ Available parameters:
     configValues: [ConfigValue: Any]? // Default: nil
 ```
 
+Biometry is used for 2FA during the payment process, thus make sure that `NSFaceIDUsageDescription` is correctly set in your target properties. 
+
 ### Native login
 You can use *AppKit* with your native login (given that your token has the necessary scopes) as well. In case of a native login,
 it is crucial that you set the configuration during setup accordingly, i.e. setting the `authenticationMode` to `.native`,
@@ -204,3 +229,13 @@ Possible errors:
 - `badRequest`: The request does not match the expected format
 - `invalidURNFormat`: The passed POI reference value does not conform to our URN format
 - `customURLSchemeNotSet`: The App tried to open an URL in `SFSafariViewController`, but deep linking has not been correctly configured
+
+## FAQ
+
+<details>
+  <summary>
+    Error "Failed to build module 'PACECloudSDK' from its module interface; the compiler that produced it may have used features that aren't supported by this compiler"
+  </summary>
+
+  Make sure that all dependencies mentioned in [specifications](#specifications) have been included and set to `Embed & Sign`.
+</details>

fastlane/Fastfile

@@ -5,23 +5,6 @@ platform :ios do
     carthage(command: 'bootstrap', cache_builds: true,  platform: 'iOS', use_binaries: false)
   end
 
-  lane :build_framework do |options|
-    carthage(
-      command: 'build',
-      no_skip_current: true,
-      cache_builds: true,
-      platform: 'iOS'
-    )
-
-    if options[:archive]
-        carthage(
-          frameworks: ['PACECloudSDK'],
-          output: 'PACECloudSDK.framework.zip',
-          command: 'archive'
-        )
-    end
-  end
-
   desc 'Run tests'
   lane :test do
     scan(
@@ -33,4 +16,8 @@ platform :ios do
       reinstall_app: true
     )
   end
+
+  lane :set_version do |options|
+    set_info_plist_value(path: 'PACECloudSDK/Info.plist', key: 'CFBundleShortVersionString', value: options[:version_number])
+  end
 end