@flakiness/report 0.23.1 → 0.24.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Flakiness Report
|
|
2
|
+
|
|
3
|
+
This folder contains the source for the `@flakiness/report` package. This
|
|
4
|
+
package is published automatically when a new version of the service is
|
|
5
|
+
deployed.
|
|
6
|
+
|
|
7
|
+
The package consists of:
|
|
8
|
+
- A CLI to interact with flakiness.io service
|
|
9
|
+
- A set of reporters for popular test runners to generate & upload Flakiness
|
|
10
|
+
report.
|
|
11
|
+
Supported test runners:
|
|
12
|
+
* [playwright/test](https://github.com/microsoft/playwright)
|
|
13
|
+
- Typescript definition of the Flakiness Report JSON
|
|
14
|
+
- Validation utilities for the Flakiness Report JSON (TBD)
|
|
15
|
+
|
|
16
|
+
## Getting Started
|
|
17
|
+
|
|
18
|
+
To start using reporter with Playwright Test:
|
|
19
|
+
|
|
20
|
+
1. Install this package:
|
|
21
|
+
```bash
|
|
22
|
+
npm i @flakiness/report@latest
|
|
23
|
+
```
|
|
24
|
+
2. Add flakiness.io to the `playwright.config.ts` file:
|
|
25
|
+
```ts
|
|
26
|
+
import { defineConfig } from '@playwright/test';
|
|
27
|
+
|
|
28
|
+
export default defineConfig({
|
|
29
|
+
reporter: [
|
|
30
|
+
['list'],
|
|
31
|
+
['@flakiness/report/playwright-test', {
|
|
32
|
+
endpoint: 'https://flakiness.io', // custom endpoint
|
|
33
|
+
token: '...', // Flakiness access token
|
|
34
|
+
collectBrowserVersion: true, // collect browser versions
|
|
35
|
+
}]
|
|
36
|
+
],
|
|
37
|
+
});
|
|
38
|
+
```
|
|
39
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flakiness/report",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.24.1",
|
|
4
4
|
"private": false,
|
|
5
5
|
"bin": {
|
|
6
6
|
"flakiness": "lib/cli/flakiness.js"
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
44
|
"@babel/code-frame": "^7.26.2",
|
|
45
|
-
"@flakiness/shared": "0.
|
|
45
|
+
"@flakiness/shared": "0.24.1",
|
|
46
46
|
"commander": "^13.1.0",
|
|
47
47
|
"debug": "^4.3.7"
|
|
48
48
|
}
|