update workflow

highmobility · Nov 8, 2023 · 012f2d8 · 012f2d8
1 parent 1bc5ca6
commit 012f2d8
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 12 deletions.
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -31,16 +31,11 @@ jobs:
           ssh-agent -a $SSH_AUTH_SOCK > /dev/null
           ssh-add - <<< "${{ secrets.GH_SSH_PRIVATE }}"
 
-      - name: create credentials.json file for the tests to read the keys
+      - name: create credentials.json files for the tests to read the keys
         run: |
           mkdir -p ~/.config/high-mobility/fleet-sdk/
           # ' will not escape "" inside the yaml file
           echo '${{ secrets.CREDENTIALS_JSON }}' > ~/.config/high-mobility/fleet-sdk/credentials.json
-
-      - name: create credentialsPrivateKey.json file for the tests to read the keys
-        run: |
-          mkdir -p ~/.config/high-mobility/fleet-sdk/
-          # ' will not escape "" inside the yaml file
           echo '${{ secrets.CREDENTIALS_JSON_PRIVATE_KEY }}' > ~/.config/high-mobility/fleet-sdk/credentialsPrivateKey.json
 
       - name: Update submodules

diff --git a/hmkit-fleet/src/main/kotlin/HMKitConfiguration.kt b/hmkit-fleet/src/main/kotlin/HMKitConfiguration.kt
@@ -16,7 +16,7 @@ class HMKitConfiguration private constructor(builder: Builder) {
       private set
 
     /**
-     * Set the credentials to be used for the SDK. Choose from either [HMKitOAuthCredentials] or [HMKitPrivateKeyCredentials].
+     * Set the credentials to be used for the SDK. Choose from either [HMKitOAuthCredentials] or [HMKitPrivateKeyCredentials]. This is a mandatory field.
      */
     fun credentials(credentials: HMKitCredentials) = apply { this.credentials = credentials }
 
@@ -26,7 +26,7 @@ class HMKitConfiguration private constructor(builder: Builder) {
     fun environment(environment: HMKitFleet.Environment) = apply { this.environment = environment }
 
     /**
-     * Set the OkHttpClient to be used for network requests.
+     * Optionally, set the OkHttpClient to be used for network requests.
      */
     fun client(client: OkHttpClient) = apply { this.client = client }
 

diff --git a/hmkit-fleet/src/main/kotlin/HMKitFleet.kt b/hmkit-fleet/src/main/kotlin/HMKitFleet.kt
@@ -39,16 +39,17 @@ import java.util.concurrent.CompletableFuture
 
 /**
  * HMKitFleet is the access point for the Fleet SDK functionality. It is accessed by
- * creating a new HMKitFleet object with a service account private key JSON string.
+ * creating a new HMKitFleet object with a HMKitConfiguration object.
  *
  * ```
  * HMKitFleet fleet = new HMKitFleet(
- *     readStringContents(service-account-private-key-{id}.json),
- *     HMKitFleet.Environment.SANDBOX
+ *     new HMKitConfiguration.Builder()
+ *      .credentials(new HMKitOAuthCredentials("client_id", "client_secret"))
+ *      .build()
  * );
  * ```
  */
-class HMKitFleet @JvmOverloads constructor(
+class HMKitFleet constructor(
   /**
    * Configure the HMKit. Use the [HMKitConfiguration.Builder] to create the object.
    */