Skip to content

Commit e16ca2d

Browse files
update doc (#84)
1 parent ed332ff commit e16ca2d

File tree

9 files changed

+767
-767
lines changed

9 files changed

+767
-767
lines changed

docs/.vitepress/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export default defineConfig({
3333
{ text: "Examples", link: "/examples/" },
3434
{ text: "Overlay Testing", link: "/overlay/" },
3535
{
36-
text: "v1.1.25",
36+
text: "v1.1.30",
3737
items: [{ text: "Changelog", link: "/changelog" }],
3838
},
3939
],

docs/overlay/examples/basic-plugin.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ workspaces/<plugin>/e2e-tests/
4545
"node": ">=22",
4646
"yarn": ">=3"
4747
},
48-
"packageManager": "yarn@3.8.7",
48+
"packageManager": "yarn@4.12.0",
4949
"description": "E2E tests for <plugin>",
5050
"scripts": {
5151
"test": "playwright test",
@@ -60,17 +60,17 @@ workspaces/<plugin>/e2e-tests/
6060
"check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
6161
},
6262
"devDependencies": {
63-
"@eslint/js": "^9.39.2",
64-
"@playwright/test": "1.57.0",
65-
"@types/node": "^24.10.1",
66-
"dotenv": "^16.4.7",
67-
"eslint": "^9.39.2",
68-
"eslint-plugin-check-file": "^3.3.1",
69-
"eslint-plugin-playwright": "^2.4.0",
70-
"prettier": "^3.7.4",
71-
"@red-hat-developer-hub/e2e-test-utils": "1.1.22",
72-
"typescript": "^5.9.3",
73-
"typescript-eslint": "^8.50.0"
63+
"@eslint/js": "10.0.1",
64+
"@playwright/test": "1.59.1",
65+
"@red-hat-developer-hub/e2e-test-utils": "1.1.30",
66+
"@types/node": "25.5.2",
67+
"dotenv": "17.4.1",
68+
"eslint": "10.2.0",
69+
"eslint-plugin-check-file": "3.3.1",
70+
"eslint-plugin-playwright": "2.10.1",
71+
"prettier": "3.8.1",
72+
"typescript": "6.0.2",
73+
"typescript-eslint": "8.58.1"
7474
}
7575
}
7676
```

docs/overlay/examples/tech-radar.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ workspaces/tech-radar/e2e-tests/
4848
"node": ">=22",
4949
"yarn": ">=3"
5050
},
51-
"packageManager": "yarn@3.8.7",
51+
"packageManager": "yarn@4.12.0",
5252
"description": "E2E tests for Tech Radar plugin",
5353
"scripts": {
5454
"test": "playwright test",
@@ -63,17 +63,17 @@ workspaces/tech-radar/e2e-tests/
6363
"check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
6464
},
6565
"devDependencies": {
66-
"@eslint/js": "^9.39.2",
67-
"@playwright/test": "1.57.0",
68-
"@types/node": "^24.10.1",
69-
"dotenv": "^16.4.7",
70-
"eslint": "^9.39.2",
71-
"eslint-plugin-check-file": "^3.3.1",
72-
"eslint-plugin-playwright": "^2.4.0",
73-
"prettier": "^3.7.4",
74-
"@red-hat-developer-hub/e2e-test-utils": "1.1.22",
75-
"typescript": "^5.9.3",
76-
"typescript-eslint": "^8.50.0"
66+
"@eslint/js": "10.0.1",
67+
"@playwright/test": "1.59.1",
68+
"@red-hat-developer-hub/e2e-test-utils": "1.1.30",
69+
"@types/node": "25.5.2",
70+
"dotenv": "17.4.1",
71+
"eslint": "10.2.0",
72+
"eslint-plugin-check-file": "3.3.1",
73+
"eslint-plugin-playwright": "2.10.1",
74+
"prettier": "3.8.1",
75+
"typescript": "6.0.2",
76+
"typescript-eslint": "8.58.1"
7777
}
7878
}
7979
```

docs/overlay/reference/environment-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ These are used by `run-e2e.sh` (the [unified test runner](/overlay/reference/run
125125
|----------|-------------|---------|
126126
| `E2E_TEST_UTILS_PATH` | Absolute path to a local `e2e-test-utils` build | - |
127127
| `E2E_TEST_UTILS_VERSION` | Pin `@red-hat-developer-hub/e2e-test-utils` npm version | `latest` (nightly), empty otherwise |
128-
| `PLAYWRIGHT_VERSION` | Pin `@playwright/test` version | `1.57.0` |
128+
| `PLAYWRIGHT_VERSION` | Pin `@playwright/test` version | `1.59.1` |
129129

130130
::: tip Version Pinning
131131
`E2E_TEST_UTILS_PATH` takes precedence over `E2E_TEST_UTILS_VERSION`. If neither is set, the version in each workspace's `package.json` is used.

docs/overlay/reference/run-e2e.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The `run-e2e.sh` script orchestrates E2E test execution across multiple workspac
3939
E2E_TEST_UTILS_PATH=/path/to/rhdh-e2e-test-utils ./run-e2e.sh -w tech-radar
4040

4141
# Pin a specific npm version of e2e-test-utils
42-
E2E_TEST_UTILS_VERSION=1.1.24 ./run-e2e.sh -w tech-radar
42+
E2E_TEST_UTILS_VERSION=1.1.30 ./run-e2e.sh -w tech-radar
4343
```
4444

4545
## Workspace Selection
@@ -72,7 +72,7 @@ A workspace is discovered when it has a `workspaces/<name>/e2e-tests/` directory
7272
| Variable | Description | Default |
7373
|----------|-------------|---------|
7474
| `CI` | Enables CI mode (forbidOnly, namespace teardown) | `true` |
75-
| `PLAYWRIGHT_VERSION` | Pin `@playwright/test` version | `1.57.0` |
75+
| `PLAYWRIGHT_VERSION` | Pin `@playwright/test` version | `1.59.1` |
7676
| `E2E_TEST_UTILS_PATH` | Absolute path to a local `e2e-test-utils` build (for testing unpublished changes) | - |
7777
| `E2E_TEST_UTILS_VERSION` | Pin `@red-hat-developer-hub/e2e-test-utils` npm version | `latest` (nightly), empty otherwise |
7878

@@ -106,8 +106,8 @@ Creates a root `package.json` with:
106106
{
107107
"workspaces": ["workspaces/tech-radar/e2e-tests", "workspaces/keycloak/e2e-tests"],
108108
"resolutions": {
109-
"@playwright/test": "1.57.0",
110-
"@red-hat-developer-hub/e2e-test-utils": "1.1.24"
109+
"@playwright/test": "1.59.1",
110+
"@red-hat-developer-hub/e2e-test-utils": "1.1.30"
111111
}
112112
}
113113
```
@@ -154,7 +154,7 @@ E2E_TEST_UTILS_PATH=/home/user/rhdh-e2e-test-utils ./run-e2e.sh -w tech-radar
154154
Use `E2E_TEST_UTILS_VERSION` to pin a published version:
155155

156156
```bash
157-
E2E_TEST_UTILS_VERSION=1.1.24 ./run-e2e.sh -w tech-radar
157+
E2E_TEST_UTILS_VERSION=1.1.30 ./run-e2e.sh -w tech-radar
158158
```
159159

160160
::: info Nightly Default

docs/overlay/test-structure/directory-layout.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Defines the test package with dependencies and scripts:
4646
"node": ">=22",
4747
"yarn": ">=3"
4848
},
49-
"packageManager": "yarn@3.8.7",
49+
"packageManager": "yarn@4.12.0",
5050
"scripts": {
5151
"test": "playwright test",
5252
"report": "playwright show-report",
@@ -60,17 +60,17 @@ Defines the test package with dependencies and scripts:
6060
"check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
6161
},
6262
"devDependencies": {
63-
"@eslint/js": "^9.39.2",
64-
"@playwright/test": "1.57.0",
65-
"@types/node": "^24.10.1",
66-
"dotenv": "^16.4.7",
67-
"eslint": "^9.39.2",
68-
"eslint-plugin-check-file": "^3.3.1",
69-
"eslint-plugin-playwright": "^2.4.0",
70-
"prettier": "^3.7.4",
71-
"@red-hat-developer-hub/e2e-test-utils": "1.1.22",
72-
"typescript": "^5.9.3",
73-
"typescript-eslint": "^8.50.0"
63+
"@eslint/js": "10.0.1",
64+
"@playwright/test": "1.59.1",
65+
"@red-hat-developer-hub/e2e-test-utils": "1.1.30",
66+
"@types/node": "25.5.2",
67+
"dotenv": "17.4.1",
68+
"eslint": "10.2.0",
69+
"eslint-plugin-check-file": "3.3.1",
70+
"eslint-plugin-playwright": "2.10.1",
71+
"prettier": "3.8.1",
72+
"typescript": "6.0.2",
73+
"typescript-eslint": "8.58.1"
7474
}
7575
}
7676
```

docs/overlay/tutorials/new-workspace.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Create `package.json` with the following content:
4141
"node": ">=22",
4242
"yarn": ">=3"
4343
},
44-
"packageManager": "yarn@3.8.7",
44+
"packageManager": "yarn@4.12.0",
4545
"description": "E2E tests for <your-plugin>",
4646
"scripts": {
4747
"test": "playwright test",
@@ -56,17 +56,17 @@ Create `package.json` with the following content:
5656
"check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
5757
},
5858
"devDependencies": {
59-
"@eslint/js": "^9.39.2",
60-
"@playwright/test": "1.57.0",
61-
"@types/node": "^24.10.1",
62-
"dotenv": "^16.4.7",
63-
"eslint": "^9.39.2",
64-
"eslint-plugin-check-file": "^3.3.1",
65-
"eslint-plugin-playwright": "^2.4.0",
66-
"prettier": "^3.7.4",
59+
"@eslint/js": "10.0.1",
60+
"@playwright/test": "1.59.1",
6761
"@red-hat-developer-hub/e2e-test-utils": "<latest-version>",
68-
"typescript": "^5.9.3",
69-
"typescript-eslint": "^8.50.0"
62+
"@types/node": "25.5.2",
63+
"dotenv": "17.4.1",
64+
"eslint": "10.2.0",
65+
"eslint-plugin-check-file": "3.3.1",
66+
"eslint-plugin-playwright": "2.10.1",
67+
"prettier": "3.8.1",
68+
"typescript": "6.0.2",
69+
"typescript-eslint": "8.58.1"
7070
}
7171
}
7272
```

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@
1717
"engines": {
1818
"node": ">=18"
1919
},
20-
"packageManager": "yarn@3.8.7"
20+
"packageManager": "yarn@4.12.0"
2121
}

0 commit comments

Comments
 (0)