Skip to content

Commit 535cd6a

Browse files
authored
docs: update example link in e2e readme (#6737)
### Summary Fixing a bad link in the readme, plus misc. ### QA Notes n/a
1 parent 44e6200 commit 535cd6a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

test/e2e/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ This document provides guidelines and setup instructions for effectively running
99
- [Dependencies](#dependencies)
1010
- [Running Tests](#running-tests)
1111
- [Test Project](#test-project)
12+
- [Pull Requests and Test Tags](#pull-requests-and-test-tags)
1213
- [Running Tests in Github Actions](#running-tests-in-github-actions)
1314
- [Notes About Updating Specific Tests](#notes-about-updating-specific-tests)
14-
- [Tests Run on PRs](#tests-run-on-prs)
1515

1616
## Test Structure Overview
1717

@@ -29,7 +29,7 @@ test/
2929

3030
### Test Template
3131

32-
An [example test](https://github.com/posit-dev/positron/blob/main/test/e2e/example.test.ts) is available to help guide you in structuring a new test.
32+
An [example test](https://github.com/posit-dev/positron/blob/main/test/e2e/tests/example.test.ts) is available to help guide you in structuring a new test.
3333

3434
## Setup
3535

@@ -231,6 +231,6 @@ When a run is complete, you can debug any test failures that occurred using the
231231

232232
In order to get the "golden screenshots" used for plot comparison is CI, you will need to temporarily uncomment the line of code marked with `capture master image in CI` or add a similar line of code for a new case. We must use CI taken snapshots because if the "golden screenshots" are taken locally, they will differ too much from the CI images to be useable with a proper threshold. You can't compare the current runtime plot against a snapshot until you have established a baseline screenshot from CI that is saved to `test/e2e/plots`.
233233

234-
## Tests run on PRs
234+
### Critical Tests
235235

236-
If you think your test should be run when PRs are created, [tag the test with @:critical](https://playwright.dev/docs/test-annotations#tag-tests). The existing @:critical cases were selected to give good overall coverage while keeping the overall execution time down to ten minutes or less. If your new test functionality covers a part of the application that no other tests cover, it is probably a good idea to include it in the @:critical set.
236+
If your test should run on all PRs, tag it with `@:critical`. Existing `@:critical` tests balance coverage and execution time (~15 min). If your test covers an untested area, consider adding it to this set. When in doubt, ask your friendly QA team.

0 commit comments

Comments
 (0)