You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: test/e2e/README.md
+12-7Lines changed: 12 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -194,23 +194,28 @@ For R, add any package requirements to the "imports" section of the `DESCRIPTION
194
194
195
195
## Pull Requests and Test Tags
196
196
197
-
When you create a pull request, the test runner automatically scans the PR description for test tags to determine which E2E tests to run.
197
+
### Test Tag Rules
198
+
199
+
When creating a pull request, the test runner automatically scans the PR description for test tags to determine which E2E tests to run.
198
200
199
201
-**Always-on Tests:** Tests tagged with `@:critical` always run, and you can’t opt out of them.
200
202
-**Custom Tags:** If your changes affect a specific feature, you can include additional tags in the PR description to trigger relevant tests.
201
203
202
-
To add a test tag:
204
+
### How to Add a Test Tag
203
205
204
-
1. Use the format `@:tag` in your PR description (e.g., `@:help`, `@:console`).
206
+
1. Use the format `@:tag`anywhere in your PR description (e.g., `@:help`, `@:console`).
205
207
2. Once added, a comment will appear on your PR confirming that the tag was found and parsed correctly.
206
208
207
-
From that point, all E2E tests linked to the specified tag(s) will run during the test job. For a full list of available tags, see this [file](https://github.com/posit-dev/positron/blob/main/test/e2e/infra/test-runner/test-tags.ts).
209
+
> [!NOTE]
210
+
> **Add tags before the `pr-tags` job starts**. If you update tags _after_ opening the PR, push a new commit or restart the jobs to apply the changes. The PR comment will confirm the detected tags, and tests will run based on the tags present at execution time.
211
+
For a full list of available tags, see this [file](https://github.com/posit-dev/positron/blob/main/test/e2e/infra/test-runner/test-tags.ts).
208
212
209
-
To include Windows and Web Browser testing:
213
+
### Running Windows and Browser Tests
210
214
211
-
By default, only Linux e2e test will run. You can optionally add `@:win` to your PR description and this will run test on windows as well. As of now, windows tests do take longer to run, so the overall PR test job will take longer to complete. You can also ass `@:web`to run the browser tests.
215
+
By default, only Linux E2E tests run. If you need to include additional environments:
212
216
213
-
Note: You can update the tags in the PR description at any time. The PR comment will confirm the parsed tags, and the test job will use the tags present in the PR description at the time of execution.
217
+
- Add `@:win` to your PR description to run tests on Windows. (Note: Windows tests take longer to complete.)
0 commit comments