Skip to content

Commit

Permalink
docs: Update contribution docs
Browse files Browse the repository at this point in the history
  • Loading branch information
LironMShemen committed Oct 15, 2024
1 parent a17a360 commit 9d1c43b
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
Binary file added artifacts__detoxtest_2024-10-15_10-04-31.tar.gz
Binary file not shown.
10 changes: 9 additions & 1 deletion docs/contributing/code/building-and-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@ cd detox/test
detox test --configuration ios.sim.release
```

:::note

Mind that on iOS, Detox expects a specific simulator device with a specific name and os version to be available in your Xcode environment.
The required details are specified in the [detox.config.js](https://github.com/wix/Detox/blob/master/detox/test/e2e/detox.config.js) under `ios.simulator` device configuration (see `type` and `os`). Be sure to [install such a device](https://developer.apple.com/documentation/safari-developer-tools/adding-additional-simulators), beforehand.

:::

To run in Android release mode, run:

```bash
Expand All @@ -87,7 +94,8 @@ detox test --configuration android.emu.release

:::note

Mind that on Android, Detox expects a specific AVD with a [specific name](https://github.com/wix/Detox/blob/24f68c3bd7675ed6f508e3f5fea97509eb7991b2/detox/test/e2e/detox.config.js#L111) to be available on your computer.
Mind that on Android, Detox expects a specific AVD with a specific name to be available on your computer.
The required details are specified in the [detox.config.js](https://github.com/wix/Detox/blob/master/detox/test/e2e/detox.config.js) under `android.emulator` device configuration (see `avdName`).
Be sure to [install such an AVD](https://developer.android.com/studio/run/managing-avds#createavd), beforehand.

:::
Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
"test:e2e:android": "pushd detox/test && npm run e2e:android && popd",
"release": "node scripts/ci.release.js",
"package:android": "node scripts/ci.android-release.js",
"package:ios": "scripts/ci.ios-release.sh"
"package:ios": "scripts/ci.ios-release.sh",
"ci.ios": "sh ./scripts/ci.ios.sh",
"ci.android": "sh ./scripts/ci.android.sh"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit 9d1c43b

Please sign in to comment.