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

Add documentation about debugging e2e tests #354

Merged
merged 4 commits into from
Mar 17, 2023
Merged

Add documentation about debugging e2e tests #354

merged 4 commits into from
Mar 17, 2023

Conversation

Eakam1007
Copy link
Contributor

Resolves #295

  • Updated the Playwright wiki page to include information about how to debug end to end tests that fail in CI
  • Added a section to CONTRIBUTING.md that links to the wiki

@Eakam1007 Eakam1007 added category: documentation Categorising, explaining how things work category: testing Unit tests, end to end tests labels Mar 15, 2023
@Eakam1007 Eakam1007 added this to the Milestone 0.6 milestone Mar 15, 2023
@Eakam1007 Eakam1007 self-assigned this Mar 15, 2023
@Eakam1007 Eakam1007 marked this pull request as ready for review March 15, 2023 18:30
sfrunza13
sfrunza13 previously approved these changes Mar 15, 2023
View reviewed changes
Copy link
Contributor

@sfrunza13 sfrunza13 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Maybe also mention that the https:/DevelopingSpace/starchart/wiki/Playwright link is also good for learning how to generate tests and use playwright in general and that navigating there is highly encouraged. Since sometimes contributors will have to be writing tests using it.

@Eakam1007
Copy link
Contributor Author

I added a separate section for end to end tests and made the debugging section a sub section

sfrunza13
sfrunza13 previously approved these changes Mar 15, 2023
View reviewed changes
Copy link
Contributor

@sfrunza13 sfrunza13 left a comment

Choose a reason for hiding this comment

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

looks good

humphd
humphd requested changes Mar 15, 2023
View reviewed changes
Copy link
Contributor

@humphd humphd left a comment

Choose a reason for hiding this comment

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

Let's add a note to the Playwright wiki page about how your setup/login/projects stuff works in the config.

The rest looks great.

@Eakam1007
Copy link
Contributor Author

Eakam1007 commented Mar 16, 2023 •
edited
Loading

I have updated the wiki with information about config, specifically the base URL, projects, and shared login state

humphd
humphd approved these changes Mar 16, 2023
View reviewed changes
Copy link
Contributor

@humphd humphd left a comment

Choose a reason for hiding this comment

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

So good!

@Eakam1007 Eakam1007 merged commit 40da747 into DevelopingSpace:main Mar 17, 2023
@Eakam1007 Eakam1007 deleted the 295-playwright-debug-docs branch March 17, 2023 06:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@humphd humphd humphd approved these changes

@sfrunza13 sfrunza13 sfrunza13 approved these changes

Assignees

@Eakam1007 Eakam1007

Labels
category: documentation Categorising, explaining how things work category: testing Unit tests, end to end tests
Projects
None yet
Milestone
Milestone 0.6
Development

Successfully merging this pull request may close these issues.

Include docs on how to understand and debug e2e tests
3 participants
@Eakam1007 @humphd @sfrunza13