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.

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

docs: Updated docs on testing Electron using WebdriverIO #39380

Conversation

christian-bromann
Copy link
Contributor

@christian-bromann christian-bromann commented Aug 6, 2023

Description of Change

Recommend users a better setup for testing Electron Applications with WebdriverIO.

Checklist

Release Notes

Notes: Updated docs on testing Electron using WebdriverIO

@electron-cation electron-cation bot added documentation 📓 semver/patch backwards-compatible bug fixes new-pr 🌱 PR opened in the last 24 hours labels Aug 6, 2023
@christian-bromann christian-bromann changed the title docs: update docs on testing Electron using WebdriverIO docs: Updated docs on testing Electron using WebdriverIO Aug 6, 2023
@christian-bromann christian-bromann force-pushed the christian-bromann-patch-1 branch 3 times, most recently from 9eb98b4 to 19d08b3 Compare August 6, 2023 23:28
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Aug 7, 2023
@codebytere codebytere requested a review from a team August 8, 2023 13:15
Copy link
Member

@codebytere codebytere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christian-bromann - someone should be round to review this more thoroughly soon, but in the meantime lint is failing due to this issue:

docs/tutorial/automated-testing.md:43:69 MD049/emphasis-style Emphasis style should be consistent [Expected: asterisk; Actual: underscore]

checks should go green once that's addressed!

notes: Updated docs on testing Electron using WebdriverIO
Copy link
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First pass on the content

chromedriver: {
logFileName: 'wdio-chromedriver.log'
},
electronVersion: '23.1.0'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're reading the package.json, shouldn't this be derived from the project's devDependencies?

// ...
}
```

The Electron service takes care of downloading the right Chromedriver version for you, updating
your capabilities to point to your Electron application as well as offers useful testing features
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
your capabilities to point to your Electron application as well as offers useful testing features
your [ChromeDriver capabilities](https://chromedriver.chromium.org/capabilities) to point to your Electron application as well as offers useful testing features

We didn't do this in the previous version of the docs either, but I think it would be helpful to link to ChromeDriver's definition of what capabilities are.

@erickzhao erickzhao added the target/26-x-y PR should also be added to the "26-x-y" branch. label Aug 8, 2023
@github-actions github-actions bot added the target/27-x-y PR should also be added to the "27-x-y" branch. label Aug 16, 2023
@christian-bromann
Copy link
Contributor Author

Closing in favor of #40083

@christian-bromann christian-bromann deleted the christian-bromann-patch-1 branch October 3, 2023 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📓 semver/patch backwards-compatible bug fixes target/26-x-y PR should also be added to the "26-x-y" branch. target/27-x-y PR should also be added to the "27-x-y" branch.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants