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

[playwright] Update documentation #13489

Merged
merged 1 commit into from
Mar 14, 2024
Merged

Conversation

marcdumais-work
Copy link
Contributor

What it does

Note: this goes along with this theia-playwright-template PR:
eclipse-theia/theia-playwright-template#9

Since a recent enhancement/refactoring of @theia/playwright [1], to permit using it in Theia Electron applications, the way to load an application has changed. This commit is an attempt to update the examples that are part of the documentation. I validated the changes in the "theia-playwright-template" repository, and so I have adapted the sample code to that repo's linting rules (using single quotes instead of double).

It's possible that other things have changed, that I have not yet encountered, but this should be a good step forward, at least for those just getting started integrating playwright to test their Theia-based app.

[1]: "Basic playwright electron support (#12207)"
487e92b

How to test

This is mostly a documentation change. I guess it could be tested after the PR listed above is merged, reproducing the documentation's examples using the latest "theia-playwright-template" code. But perhaps a visual inspection could be enough.

Follow-ups

Review checklist

Reminder for reviewers

Since a recent enhancement/refactoring of @theia/playwright, to permit using it in Theia
Electron applications, the way to load an application has changed. This commit is an
attempt to update the examples that are part of the documentation. I validated the changes
in the "theia-playwright-template" repository, and so I have adapted the sample code to
that repo's linting rules (using single quotes instead of double).

It's possible that other things have changed, that I have not yet encountered, but this
should be a good step forward, at least for those just getting started integrating
playwright to test their Theia-based app.

Signed-off-by: Marc Dumais <marc.dumais@ericsson.com>
Copy link
Contributor

@planger planger left a comment

Choose a reason for hiding this comment

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

Thank you very much @marcdumais-work! We totally missed updating the docs when adding the Electron support. Your changes look good to me! 👍

@marcdumais-work
Copy link
Contributor Author

Thanks for the quick review @planger !
Ok to merge?

@planger
Copy link
Contributor

planger commented Mar 14, 2024

@marcdumais-work Yes, I'm fine to merge it.
Just as a heads-up, in #13491 I've removed some deprecated API and actions. We should probably also switch in this template to Node 18 and avoid using the deprecated GabrielBB/xvfb-action@v1 GH action.

Edit: forgot to add link to https://github.com/eclipse-theia/theia-playwright-template

@marcdumais-work
Copy link
Contributor Author

in #13491 I've removed some deprecated API and actions. We should probably also switch in this template to Node 18 and avoid using the deprecated GabrielBB/xvfb-action@v1 GH action.

Would similarly updating the workflow for theia-playwright-template be welcomed, as part of eclipse-theia/theia-playwright-template#9?

@marcdumais-work marcdumais-work merged commit 92cbb85 into master Mar 14, 2024
13 of 14 checks passed
@marcdumais-work marcdumais-work deleted the playwright-doc-update branch March 14, 2024 13:21
@marcdumais-work marcdumais-work added the playwright issues related to playwright tests label Mar 14, 2024
@github-actions github-actions bot added this to the 1.48.0 milestone Mar 14, 2024
@planger
Copy link
Contributor

planger commented Mar 14, 2024

in #13491 I've removed some deprecated API and actions. We should probably also switch in this template to Node 18 and avoid using the deprecated GabrielBB/xvfb-action@v1 GH action.

Would similarly updating the workflow for theia-playwright-template be welcomed, as part of eclipse-theia/theia-playwright-template#9?

Yes. definitely! That would be great. However, don't feel obligated to do it, I'm happy to put it on our list too. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
playwright issues related to playwright tests
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants