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 docs on testing Electron apps with WebdriverIO #40083

Merged
merged 10 commits into from Oct 16, 2023
Merged

docs: Update docs on testing Electron apps with WebdriverIO #40083

merged 10 commits into from Oct 16, 2023

Conversation

christian-bromann
Copy link
Contributor

@christian-bromann christian-bromann commented Oct 3, 2023 •
edited

Description of Change

We recently have released a new major version of our Electron plugin that makes testing Electron apps even easier. This PR updates the description on Testing Electron apps with WebdriverIO:

  • have user run through the config wizard which sets up all necessary dependencies for testing Electron apps
  • adds code example on how a config should look like
  • adds example tests how to retrieve data from the Electron API
  • adds links to further resources on webdriver.io

Checklist

  • npm test passes
  • relevant documentation, tutorials, templates and examples are changed or added

Release Notes

Notes: none

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Oct 3, 2023
@christian-bromann christian-bromann mentioned this pull request Oct 3, 2023
Closed
5 tasks
@christian-bromann christian-bromann changed the title Update docs on testing Electron apps with WebdriverIO docs: Update docs on testing Electron apps with WebdriverIO Oct 3, 2023
@electron-cation electron-cation bot added documentation 📓 semver/patch backwards-compatible bug fixes labels Oct 3, 2023
felixrieseberg
felixrieseberg approved these changes Oct 4, 2023
View reviewed changes
Copy link
Member

@felixrieseberg felixrieseberg left a comment

Choose a reason for hiding this comment

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

I know that @erickzhao had some thoughts, too, so we should only merge until he's had a chance to look at it!

I really appreciate the work you've done - both in code and in documentation here. The new API looks really intuitive and I bet it'll make testing apps so much easier for so many people. Thank you!

docs/tutorial/automated-testing.md Outdated Show resolved Hide resolved
docs/tutorial/automated-testing.md Outdated Show resolved Hide resolved
christian-bromann and others added 2 commits October 4, 2023 09:31
@christian-bromann @felixrieseberg
Update docs/tutorial/automated-testing.md
4158b30 
Co-authored-by: Felix Rieseberg <fr@makenotion.com>
@christian-bromann @felixrieseberg
Update docs/tutorial/automated-testing.md
d4d3389 
Co-authored-by: Felix Rieseberg <fr@makenotion.com>
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Oct 4, 2023
@erickzhao erickzhao added target/27-x-y PR should also be added to the "27-x-y" branch. target/28-x-y PR should also be added to the "28-x-y" branch. labels Oct 16, 2023
erickzhao
erickzhao approved these changes Oct 16, 2023
View reviewed changes
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.

Content in this is great. Thanks Christian! Going to leave a second review just for copy editing.

docs/tutorial/automated-testing.md Outdated
@@ -27,29 +27,94 @@ Node.js package for testing with WebDriver. Its ecosystem also includes various
First you need to run the WebdriverIO starter toolkit in your project root directory:
Copy link
Member

Choose a reason for hiding this comment

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

I think it would be nice to note in the first paragraph at what WDIO version Electron support was added, in case a project is already using WDIO and needs to upgrade to get the latest capabilities.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

addressed in a9849ac

erickzhao
erickzhao reviewed Oct 16, 2023
View reviewed changes
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.

Copy editing

docs/tutorial/automated-testing.md Outdated Show resolved Hide resolved
docs/tutorial/automated-testing.md Outdated Show resolved Hide resolved
docs/tutorial/automated-testing.md Outdated Show resolved Hide resolved
docs/tutorial/automated-testing.md Outdated Show resolved Hide resolved
docs/tutorial/automated-testing.md Outdated Show resolved Hide resolved
christian-bromann and others added 6 commits October 16, 2023 11:29
@christian-bromann
address PR comments
a9849ac
@christian-bromann @erickzhao
Update docs/tutorial/automated-testing.md
b49a3df 
Co-authored-by: Erick Zhao <erick@hotmail.ca>
@christian-bromann @erickzhao
Update docs/tutorial/automated-testing.md
7840047 
Co-authored-by: Erick Zhao <erick@hotmail.ca>
@christian-bromann @erickzhao
Update docs/tutorial/automated-testing.md
ba359cc 
Co-authored-by: Erick Zhao <erick@hotmail.ca>
@christian-bromann @erickzhao
Update docs/tutorial/automated-testing.md
df9d312 
Co-authored-by: Erick Zhao <erick@hotmail.ca>
@christian-bromann @erickzhao
Update docs/tutorial/automated-testing.md
c269bfa 
Co-authored-by: Erick Zhao <erick@hotmail.ca>
erickzhao
erickzhao approved these changes Oct 16, 2023
View reviewed changes
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.

docs: lgtm

electron-docs-reviewer[bot]
electron-docs-reviewer bot approved these changes Oct 16, 2023
View reviewed changes
Copy link

@electron-docs-reviewer electron-docs-reviewer bot left a comment

Choose a reason for hiding this comment

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

Approving on behalf of the Electron Docs Team

@VerteDinde VerteDinde merged commit ba4d6d0 into electron:main Oct 16, 2023
15 checks passed
@release-clerk
Copy link

release-clerk bot commented Oct 16, 2023

No Release Notes

This was referenced Oct 16, 2023
Merged
Merged
@trop
Copy link
Contributor

trop bot commented Oct 16, 2023

I have automatically backported this PR to "27-x-y", please check out #40226

@trop
Copy link
Contributor

trop bot commented Oct 16, 2023

I have automatically backported this PR to "28-x-y", please check out #40227

@trop trop bot added in-flight/28-x-y and removed target/27-x-y PR should also be added to the "27-x-y" branch. target/28-x-y PR should also be added to the "28-x-y" branch. labels Oct 16, 2023
@christian-bromann christian-bromann deleted the patch-2 branch October 16, 2023 20:30
@christian-bromann
Copy link
Contributor Author

Thanks team, don't hesitate to reach out if folks report any e2e test issues or direct them to the WebdriverIO discord channel.

@trop trop bot added merged/28-x-y PR was merged to the "28-x-y" branch. merged/27-x-y PR was merged to the "27-x-y" branch. and removed in-flight/28-x-y in-flight/27-x-y labels Oct 17, 2023
felixrieseberg pushed a commit to felixrieseberg/electron that referenced this pull request Oct 25, 2023
@christian-bromann @felixrieseberg
docs: Update docs on testing Electron apps with WebdriverIO (electron…
7fec992 
…#40083)
MrHuangJser pushed a commit to MrHuangJser/electron that referenced this pull request Dec 11, 2023
@christian-bromann
docs: Update docs on testing Electron apps with WebdriverIO (electron…
ba6b544 
…#40083)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@felixrieseberg felixrieseberg felixrieseberg approved these changes

@VerteDinde VerteDinde VerteDinde approved these changes

@erickzhao erickzhao erickzhao approved these changes

@electron-docs-reviewer electron-docs-reviewer[bot] electron-docs-reviewer approved these changes

Assignees
No one assigned
Labels
documentation 📓 merged/27-x-y PR was merged to the "27-x-y" branch. merged/28-x-y PR was merged to the "28-x-y" branch. semver/patch backwards-compatible bug fixes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@christian-bromann @felixrieseberg @VerteDinde @erickzhao