Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update contribution docs #4613

Merged
merged 1 commit into from
Oct 15, 2024
Merged

docs: Update contribution docs #4613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added artifacts__detoxtest_2024-10-15_10-04-31.tar.gz
View file
Open in desktop
Binary file not shown.
14 changes: 11 additions & 3 deletions docs/contributing/code/building-and-testing.md
View file
Open in desktop
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 Expand Up @@ -127,8 +135,8 @@ On our CI, we test our changes on both iOS and Android, and we lint-check our co
You can run the same scripts we run on our CI locally, to ensure your changes are passing the tests (under the project's root directory):

```bash
npm run ci.ios
npm run ci.android
npm run ci:ios
npm run ci:android
```

Refer to the scripts `scripts/ci.ios.sh` and `scripts/ci.android.sh` to see how we run the tests on our CI.
Expand Down
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
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
Loading