Skip to content

Commit

Permalink
docs: add binary path examples
Browse files Browse the repository at this point in the history
  • Loading branch information
goosewobbler committed Dec 20, 2024
1 parent 1d69f92 commit 518b121
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions docs/configuration/service-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,22 +51,29 @@ Type: `string[]`

The path to the Electron binary of the app for testing. In most cases the service will determine the path to your app automatically [(check here)](#automatic-detection-of-app-binary), but if this fails for some reason, e.g. your app is in a different repository from your tests, then it is recommended to set this value manually.

If you manually set the path to the Electron binary, make sure you set the path correctly for MacOS
If you manually set the path to the Electron binary, the path will be in different formats depending on the build tool you are using, how that tool is configured, and which OS you are building the app on.

Here are some examples of binary paths using default build configurations for a hypothetical app called `myApp` which is built in the `workspace/myApp` directory:

#### MacOS

```ts
export const config = {
// ...
capabilities: [
{
// ...
'wdio:electronServiceOptions': {
appBinaryPath: '/foo/bar/myOtherApp.app/Contents/MacOS/myOtherApp',
// ...
},
},
],
// ...
};
'/workspace/myApp/dist/myApp.app/Contents/MacOS/myApp'; // Electron Builder
'/workspace/myApp/out/myApp.app/Contents/MacOS/myApp'; // Electron Forge
```

#### Linux

```ts
'/workspace/myApp/dist/myApp'; // Electron Builder
'/workspace/myApp/out/myApp'; // Electron Forge
```

#### Windows

```ts
'/workspace/myApp/dist/myApp.exe'; // Electron Builder
'/workspace/myApp/out/myApp.exe'; // Electron Forge
```

Type: `string`
Expand Down

0 comments on commit 518b121

Please sign in to comment.