Merge pull request #7 from devicecloud-dev/intelligent-retries

support intelligent retries

Author: riglar

README.md

@@ -269,3 +269,15 @@ Specify an iOS device model to run your tests on:
     app-file: app.zip
     ios-device: iphone-14
 ```
+
+# Retry parameter
+
+The `retry` parameter allows you to specify the number of times to retry the run if it fails. This is the same as pressing retry in the UI, and it will deduct credits from your account. Max is 3 retries.
+
+```yaml
+- uses: devicecloud-dev/device-cloud-for-maestro@v1
+  with:
+    api-key: ${{ secrets.DCD_API_KEY }}
+    app-file: app.apk
+    retry: 3
+```

action.yml

@@ -63,12 +63,15 @@ inputs:
     description: 'A custom name for your upload (useful for tagging commits etc)'
     required: false
   orientation:
-    description: 'Android only - The orientation of the device to run your flow against in degrees (0|90|180|270)'
+    description: 'Android only - The orientation of the device to run your flow against in degrees (90|180|270)'
     required: false
   workspace:
     description: 'Path to a folder that contains your test flows'
     required: false
     default: './.maestro/'
+  retry:
+    description: 'Number of times to retry the run if it fails (same as pressing retry in the UI, this will deduct credits from your account)'
+    required: false
 
 runs:
   using: 'node20'

package.json

@@ -2,7 +2,7 @@
   "name": "dcd-github-action",
   "description": "run maestro tests on devicecloud.dev",
   "author": "devicecloud.dev",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "main": "src/index.ts",
   "license": "MIT",
   "engines": {

src/index.ts

@@ -26,6 +26,7 @@ const run = async (): Promise<void> => {
       maestroVersion,
       name,
       orientation,
+      retry,
       workspaceFolder,
     } = await getParameters();
 
@@ -51,6 +52,7 @@ const run = async (): Promise<void> => {
       'maestro-version': maestroVersion,
       name,
       orientation,
+      retry,
     };
 
     let paramsString = Object.keys(params).reduce((acc, key) => {

src/methods/params.ts

@@ -24,6 +24,7 @@ export type Params = {
   downloadArtifacts?: 'ALL' | 'FAILED';
   maestroVersion?: string;
   orientation?: 0 | 90 | 180 | 270;
+  retry?: number;
 };
 
 function getAndroidApiLevel(apiLevel?: string): number | undefined {
@@ -191,6 +192,9 @@ export async function getParameters(): Promise<Params> {
   const androidApiLevel = getAndroidApiLevel(androidApiLevelString);
   const iOSVersion = getIOSVersion(iOSVersionString);
 
+  const retry =
+    parseInt(core.getInput('retry', { required: false })) || undefined;
+
   return {
     apiUrl,
     apiKey,
@@ -214,5 +218,6 @@ export async function getParameters(): Promise<Params> {
     downloadArtifacts,
     maestroVersion,
     orientation,
+    retry,
   };
 }