-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
build: update Kotlin to 1.9.20 (#122)
Signed-off-by: Ahmed Moussa <[email protected]>
- Loading branch information
Showing
28 changed files
with
197 additions
and
430 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Apollo | ||
|
|
||
| [](http://kotlinlang.org) | ||
| [](http://kotlinlang.org) | ||
| [](https://github.com/input-output-hk/atala-prism-apollo/actions/workflows/pull-request.yml) | ||
| [](https://github.com/input-output-hk/atala-prism-apollo/actions/workflows/Deployment.yml) | ||
|
|
||
|
|
@@ -11,8 +11,6 @@ | |
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|  | ||
|
|
||
|
|
@@ -25,6 +23,18 @@ A cryptography lib built with Kotlin Multiplatform with support for the followin | |
|
|
||
| ## How to build Apollo | ||
|
|
||
| ### Set Environment Variables | ||
|
|
||
| Set variable `ATALA_GITHUB_ACTOR` with your GitHub Username and set variable `ATALA_GITHUB_TOKEN` with your GitHub Personal Access Token. | ||
|
|
||
| As an example we will go with `Bash` | ||
|
|
||
| 1. Open CMD. | ||
| 2. Run `sudo nano $HOME/.bash_profile`. | ||
| 3. Insert `export ATALA_GITHUB_ACTOR="YOUR GITHUB USERNAME"` | ||
| 4. Insert `export ATALA_GITHUB_TOKEN="YOUR GITHUB PERSONAL ACCESS TOKEN"` | ||
| 5. Save profile and restart CMD to take effect. | ||
|
|
||
| ### Install Homebrew (Mac Only) | ||
|
|
||
| ```bash | ||
|
|
@@ -101,6 +111,14 @@ You should be able to import and build the project in IntelliJ IDEA now. | |
| Here is a list of common issues you might face and its solutions. | ||
| ##### Enviroment Variables were added but not available | ||
| If you already added the envorment variable to your CMD profile and still not being available. | ||
| **Solution** | ||
| * Restart your Device. | ||
| ##### No binary for ChromeHeadless browser on your platform | ||
| If you get error: | ||
|
|
@@ -132,25 +150,66 @@ Could not find JNA native support | |
| * Make sure that you are using Java version that is arch64. | ||
| ## How to use for JVM/Android app | ||
| TBD | ||
| ## How to use for iOS app | ||
| TBD | ||
| In `build.gradle.kts` files include the dependency | ||
| ```kotlin | ||
| repositories { | ||
| mavenCentral() | ||
| maven { | ||
| this.url = uri("https://maven.pkg.github.com/input-output-hk/atala-prism-apollo") | ||
| credentials { | ||
| this.username = // GitHub Username | ||
| this.password = // GitHub Access Token | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| For dependencies | ||
| ```kotlin | ||
| dependencies { | ||
| val apolloVersion = ... // Latest Apollo Version | ||
| implementation("io.iohk.atala.prism.apollo:apollo:$apolloVersion") | ||
| } | ||
| ``` | ||
| ## How to use for JS app | ||
| TBD | ||
| ## How to use for iOS app | ||
| ## How to use for NodeJS app | ||
| TBD | ||
| ### Using SPM | ||
| ## How to use for Python | ||
| TBD | ||
| Inside your `Package.swift` file, add the following | ||
| ```swift | ||
| dependencies: [ | ||
| .package( | ||
| url: "[email protected]:input-output-hk/atala-prism-apollo.git", | ||
| from: "latest versoin" | ||
| ) | ||
| ] | ||
| ``` | ||
| ### Using generated xcframework directly | ||
| The following instruction using Xcode 15 | ||
| 1. Go the [Release Page](https://github.com/input-output-hk/atala-prism-apollo/releases) and check the latest version and download the `Apollo.xcframework.zip` file. | ||
| 2. Uncompress the downloaded file. | ||
| 3. Add the `Apollo.xcframework` to your Xcode project. | ||
| 4. When asked select Copy items if needed. | ||
| 5. Then go to the project configuration page in Xcode and check the Frameworks and Libraries section and add the `Apollo.xcframework` if not found then choose `Embed & Sign`. | ||
| 6. Then go to the build phase page and mark the framework as required. | ||
| ## How to use for Node.js app | ||
| Inside the `package.json` | ||
| ```json | ||
| { | ||
| "dependencies": { | ||
| "@atala/apollo": "latest version of Apollo" | ||
| } | ||
| } | ||
| ``` | ||
| ## How to use for Scala | ||
| TBD | ||
| ## How to use for another KMP (Kotlin Multiplatform) project | ||
| ## How to use for another KMM project | ||
| You need to do the following: | ||
| 1. You need to let Gradle know where to search for the Apollo package | ||
| 2. Import the packages in the common target as per your project needs | ||
| 1. Once you insert the import in the common target, it will automatically retrieve each supported target knowing that the currently only available targets are: | ||
|
|
@@ -161,26 +220,13 @@ You need to do the following: | |
| |------------------------------------------|--------------------| | ||
| | iOS x86 64 | :heavy_check_mark: | | ||
| | iOS Arm 64 | :heavy_check_mark: | | ||
| | iOS Arm 32 | :heavy_check_mark: | | ||
| | iOS Simulator Arm 64 (Apple Silicon) | :heavy_check_mark: | | ||
| | JVM | :heavy_check_mark: | | ||
| | Android | :heavy_check_mark: | | ||
| | JS Browser | :heavy_check_mark: | | ||
| | NodeJS Browser | :heavy_check_mark: | | ||
| | macOS X86 64 | :heavy_check_mark: | | ||
| | macOS Arm 64 (Apple Silicon) | :heavy_check_mark: | | ||
| | watchOS X86 32 | :heavy_check_mark: | | ||
| | watchOS Arm 64(_32) | :heavy_check_mark: | | ||
| | watchOS Arm 32 | :heavy_check_mark: | | ||
| | watchOS Simulator Arm 64 (Apple Silicon) | :heavy_check_mark: | | ||
| | tvOS X86 64 | :heavy_check_mark: | | ||
| | tvOS Arm 64 | :heavy_check_mark: | | ||
| | tvOS Simulator Arm 64 (Apple Silicon) | :heavy_check_mark: | | ||
| | Linux X86 64 | :x: | | ||
| | Linux Arm 64 | :x: | | ||
| | Linux Arm 32 | :x: | | ||
| | minGW X86 64 | :x: | | ||
| | minGW X86 32 | :x: | | ||
| **For the first, second & third point** we have two cases using Groovy and using Kotlin DSL | ||
|
|
@@ -194,8 +240,8 @@ allprojects { | |
| maven { | ||
| url = uri("https://maven.pkg.github.com/input-output-hk/atala-prism-apollo") | ||
| credentials { | ||
| username = System.getenv("ATALA_GITHUB_ACTOR") // this is CMD system environment and you can replace the retrieval of its value to any other preferable way if needed | ||
| password = System.getenv("ATALA_GITHUB_TOKEN") // this is CMD system environment and you can replace the retrieval of its value to any other preferable way if needed | ||
| username = // GitHub Username | ||
| password = // GitHub Access Token | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -204,13 +250,6 @@ allprojects { | |
| In the module `build.gradle` | ||
| ```groovy | ||
| kotlin { | ||
| // if you are going to use the iOS as one of the KMM module target. You need to use the new iOS hierarchy | ||
| ios() // New iOS hierarchy | ||
| // instead of the old way | ||
| iosX64() | ||
| iosArm64() | ||
| iosSimulatorArm64() | ||
| sourceSets { | ||
| commonMain { | ||
| dependencies { | ||
|
|
@@ -232,22 +271,15 @@ allprojects { | |
| maven { | ||
| url = uri("https://maven.pkg.github.com/input-output-hk/atala-prism-apollo") | ||
| credentials { | ||
| username = System.getenv("ATALA_GITHUB_ACTOR") // this is CMD system environment, and you can replace the retrieval of its value to any other preferable way if needed | ||
| password = System.getenv("ATALA_GITHUB_TOKEN") // this is CMD system environment, and you can replace the retrieval of its value to any other preferable way if needed | ||
| username = // GitHub Username | ||
| password = // GitHub Access Token | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| ```kotlin | ||
| kotlin { | ||
| // if you are going to use the iOS as one of the KMM module target. You need to use the new iOS hierarchy | ||
| ios() // New iOS hierarchy | ||
| // instead of the old way | ||
| iosX64() | ||
| iosArm64() | ||
| iosSimulatorArm64() | ||
| sourceSets { | ||
| val commonMain by getting { | ||
| dependencies { | ||
|
|
@@ -259,7 +291,7 @@ kotlin { | |
| } | ||
| ``` | ||
| **For the third point** | ||
| You need to use Kotlin version `1.7.21`. | ||
| You need to use Kotlin version `1.9.20`. | ||
| ## Usage | ||
|
|
||
Oops, something went wrong.