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

frontend: edit docs for playwright #1930

Merged
merged 1 commit into from May 13, 2024
Merged

frontend: edit docs for playwright #1930

merged 1 commit into from May 13, 2024

Conversation

vyncent-t
Copy link
Contributor

@vyncent-t vyncent-t commented Apr 25, 2024

Update Documentation for Local Playwright End-to-End Tests

Description

This PR updates the existing documentation to include more detailed instructions on setting up and running local Playwright end-to-end tests. The enhancements aim to provide developers with clear guidelines on how to effectively utilize Playwright for testing their local developments, ensuring that they can quickly and efficiently verify changes before deployment.

Changes

  • Expanded the documentation to include step-by-step setup instructions for running Playwright locally.
  • Added options for preferences using configurations to playwright.config.ts

Verification

  • Ensured that all new documentation content is clear, accurate, and easy to follow.
  • Tested the setup instructions and test execution steps to ensure they are applicable and functional.
  • Reviewed the documentation for technical accuracy and coherence with existing documentation standards.

@vyncent-t vyncent-t self-assigned this Apr 25, 2024
@vyncent-t vyncent-t marked this pull request as ready for review April 25, 2024 17:33
@vyncent-t vyncent-t requested a review from illume April 25, 2024 20:37
@vyncent-t vyncent-t added documentation Improvements or additions to documentation e2e-tests End to end tests labels Apr 25, 2024
@sniok
Copy link
Contributor

sniok commented Apr 26, 2024

Something that could be useful is a development guide, like how to create, change and validate tests and also how to run tests against a local frontend build. Also we should probably mention the playwright --ui[0] option which I think is really useful

[0] https://playwright.dev/docs/test-ui-mode

Copy link
Collaborator

@joaquimrocha joaquimrocha left a comment

Choose a reason for hiding this comment

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

Left a comment. Otherwise, it feels like Olek's idea of mentioning --ui is a good one.

e2e-tests/README.md Show resolved Hide resolved
@joaquimrocha
Copy link
Collaborator

@skoeva Can you confirm/test these steps?

@joaquimrocha joaquimrocha requested a review from skoeva May 10, 2024 15:06
skoeva
skoeva previously requested changes May 10, 2024
Copy link
Contributor

@skoeva skoeva left a comment

Choose a reason for hiding this comment

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

other than these changes, LGTM

e2e-tests/README.md Outdated Show resolved Hide resolved
e2e-tests/README.md Outdated Show resolved Hide resolved
@vyncent-t
Copy link
Contributor Author

rebased and added a section for the UI mode

Copy link
Contributor

@illume illume left a comment

Choose a reason for hiding this comment

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

🎉🎈 Thanks.

@illume illume dismissed skoeva’s stale review May 13, 2024 08:58

Requested changes were done, and there was a "LGTM otherwise".

@illume illume merged commit 45b8420 into main May 13, 2024
5 checks passed
@illume illume deleted the e2e-docs-edit branch May 13, 2024 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation e2e-tests End to end tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants