docs(junit): document existing options and env (#30595)

This commit is contained in:
Yury Semikhatsky 2024-04-29 11:29:15 -07:00 committed by GitHub
parent fb90797d73
commit b9f70f4ac4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -263,6 +263,12 @@ export default defineConfig({
});
```
JSON report supports following configuration options and environment variables:
| Environment Variable Name | Reporter Config Option| Description | Default
|---|---|---|---|
| `PLAYWRIGHT_JUNIT_OUTPUT_NAME` | `outputFile` | Report file path. | JSON report is printed to stdout.
### JUnit reporter
JUnit reporter produces a JUnit-style xml report.
@ -293,6 +299,16 @@ export default defineConfig({
});
```
JUnit report supports following configuration options and environment variables:
| Environment Variable Name | Reporter Config Option| Description | Default
|---|---|---|---|
| `PLAYWRIGHT_JUNIT_OUTPUT_NAME` | `outputFile` | Report file path. | JUnit report is printed to stdout.
| | `stripANSIControlSequences` | Whether to remove ANSI control sequences from the text before writing it in the report. | By default output text is added as is.
| | `includeProjectInTestName` | Whether to include Playwright project name in every test case as a name prefix. | By default not included.
| `PLAYWRIGHT_JUNIT_SUITE_ID` | | Value of the `id` attribute on the root `<testsuites/>` report entry. | Empty string.
| `PLAYWRIGHT_JUNIT_SUITE_NAME` | | Value of the `name` attribute on the root `<testsuites/>` report entry. | Empty string.
### GitHub Actions annotations
You can use the built in `github` reporter to get automatic failure annotations when running in GitHub actions.