Skip to content

Commit

Permalink
Refined cacheId documentation
Browse files Browse the repository at this point in the history
- Added information about the actual value that can be used for cacheId (which is 'any'), based on customer feedback (they were unsure where to retrieve the "magic" value from our docs)
- Fixed a link to the cacheId anchor
  • Loading branch information
steilerDev authored Aug 13, 2024
1 parent 3b07fb4 commit 8d6ec24
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/dev/test-configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -718,7 +718,7 @@ If set to `true` it prevents the device from resetting before the session startu

**For Real Devices:**

Set `noReset` to `true` to keep a device allocated to you during the device cleaning process, as described under [`cacheId`](#`cacheId`), allowing you to continue testing on the same device. Default value is `false`. To use `noReset`, you must pair it with `cacheId`.
Set `noReset` to `true` to keep a device allocated to you during the device cleaning process, as described under [`cacheId`](#cacheId), allowing you to continue testing on the same device. Default value is `false`. To use `noReset`, you must pair it with `cacheId`.

**For Virtual Devices:**

Expand Down Expand Up @@ -1378,7 +1378,7 @@ If [`noReset`](#noreset) is also set to `true`, the app under test and its data
Changing [`noReset`](#noreset) has no impact here. The app will not be removed, will stay on the phone/tablet and will keep it's state. This is caused by the re-signing process of the app.
:::

If you are running multiple test suites in parallel, the values for `cacheId` should be unique for each suite (to avoid mixing up the devices), and the value for `cacheId` must be the same for all test methods that you want to run on the cached device. In addition, the app and project ID used for the tests must remain the same, along with the values for these capabilities:
If you are running multiple test suites in parallel, the values for `cacheId` should be unique for each suite (to avoid mixing up the devices), and the value for `cacheId` must be the same for all test methods that you want to run on the cached device. The value itself can be any (random) string. In addition, the app and project ID used for the tests must remain the same, along with the values for these capabilities:

- `platformName`
- `appium:deviceName`
Expand Down

0 comments on commit 8d6ec24

Please sign in to comment.