From 9f04d9758f7231a0a26e2727f11ee07b918ae307 Mon Sep 17 00:00:00 2001 From: Shantanu Wali <98103945+Private1647@users.noreply.github.com> Date: Tue, 2 Sep 2025 14:45:39 +0530 Subject: [PATCH] Update kaneai-ci-cd-automation.md --- docs/kaneai-ci-cd-automation.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/docs/kaneai-ci-cd-automation.md b/docs/kaneai-ci-cd-automation.md index 247ef5803..46b9d7775 100644 --- a/docs/kaneai-ci-cd-automation.md +++ b/docs/kaneai-ci-cd-automation.md @@ -79,6 +79,10 @@ Replace `` with the actual ID from the URL and set additional optiona - **tunnel**: Add the parameter and tunnel name if you want to run using LambdaTest Tunnel for private applications. See more details for tunnel [here](https://www.lambdatest.com/support/docs/kane-ai-geolocation-tunnel-proxy/#tunnel-support). - **dedicated_proxy**: Add the region of the dedicated proxy such as _us_ or _eu_, #Optional, either tunnel or dedicated proxy or geolocation can be used in a single API call. - **geolocation**: Add the resgion of the geolocation that you want to run your tests from. You can find the list of support geolocations [here](https://www.lambdatest.com/support/docs/selenium-geolocation-capabilities/). +- **environment_id**: Define the environment on which you want to run the test run if required. +- **retry_on_failure**: Define if you want to retry in case of failure (Boolean). If "retry_on_failure" is false, the default max retries will still be 1. +- **max_retries**: Define the number of maximum retries you want (Max value 5). Default retries 1. +- **timezone**: Define the timezone you want to choose for test run in UTC+01:00 format. - **app_profiling**: Add true if you want to track app profiling metrics in your test. You can find more details [here](https://www.lambdatest.com/support/docs/appium-app-performance-analytics/). - **performance**: Add true if you want generate Lighthouse report for your web tests. Supported on limited OS browser combinations. Additionally, Setting this as true could potentially slow down the execution time. You can find more details [here](https://www.lambdatest.com/support/docs/view-lighthouse-performance-metrics/). - **accessibility**: Set as true if you want to run accessibility test on all your tests in the test run. Setting this as true could potentially slow down the execution time. @@ -92,18 +96,31 @@ curl --location 'https://test-manager-api.lambdatest.com/api/atm/v1/hyperexecute --header 'Authorization: Basic ' \ --data '{ "test_run_id": "YOUR_TEST_RUN_ID", #enter test run id - "concurrency": 1, # Optional, Default 1 + "concurrency": 1, # Optional, default 1 "title": "UNIQUE_BUILD_NAME", #Optional "console_logs": "false", #Optional for web tests, options - false, error, warn, info, true - "network_logs": "false", #Optional to capture network requests during the test + "network_logs": "false", #Optional to capture network calls during the test + "network_full_har": "false", #Optional, Only for web, to capture complete network requests & response during the test "region": "YOUR_DESIRED_REGION", #Optional for web tests, options - eastus, centralindia "mobile_region": "YOUR_DESIRED_REGION", #Optional for mobile tests, options - us,eu,ap "tunnel": "tunnel-name", #Optional, either tunnel or dedicated proxy or geolocation can be used "dedicated_proxy": "region", #Optional, either tunnel or dedicated proxy or geolocation can be used - "geolocation": "region", #Optional, either tunnel or dedicated proxy or geolocation can be used. + "geolocation": "region", #Optional, either tunnel or dedicated proxy or geolocation can be used + "environment_id": 0, #Optional, default null, to define the environment for test run + "retry_on_failure": "true", #Optional, default true, to define if retry is needed in case of failure + "max_retries": 1, #Optional, default 1, to define the number of retries needed if retry_on_failure is enabled + "timezone": "UTC+01:00", #Optional, Only for web, to define the timezone using which the test runs should run "app_profiling": "false", #Optional for performance metrics for native mobile apps "performance": "false", #Optional for lighthouse report for web tests "accessibility": "false", #Optional only for web tests + "network_throttle": { + "label": "No Throttling", + "value": "default", + "download_speed": 0, + "upload_speed": 0, + "latency": 0, + "honor_network": true + }, #Optional, only for mobile tests, to define if sessions needs to be enabled with network throttling enabled "replaced_url": [ { "pattern_url": "TEST_URL_1",