Skip to content

update doc #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
subhashkhileri merged 1 commit into from
Apr 10, 2026
Merged

update doc #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/.vitepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export default defineConfig({
{ text: "Examples", link: "/examples/" },
{ text: "Overlay Testing", link: "/overlay/" },
{
text: "v1.1.25",
text: "v1.1.30",
items: [{ text: "Changelog", link: "/changelog" }],
},
],
Expand Down
24 changes: 12 additions & 12 deletions docs/overlay/examples/basic-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ workspaces/<plugin>/e2e-tests/
"node": ">=22",
"yarn": ">=3"
},
"packageManager": "yarn@3.8.7",
"packageManager": "yarn@4.12.0",
"description": "E2E tests for <plugin>",
"scripts": {
"test": "playwright test",
Expand All @@ -60,17 +60,17 @@ workspaces/<plugin>/e2e-tests/
"check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
},
"devDependencies": {
"@eslint/js": "^9.39.2",
"@playwright/test": "1.57.0",
"@types/node": "^24.10.1",
"dotenv": "^16.4.7",
"eslint": "^9.39.2",
"eslint-plugin-check-file": "^3.3.1",
"eslint-plugin-playwright": "^2.4.0",
"prettier": "^3.7.4",
"@red-hat-developer-hub/e2e-test-utils": "1.1.22",
"typescript": "^5.9.3",
"typescript-eslint": "^8.50.0"
"@eslint/js": "10.0.1",
"@playwright/test": "1.59.1",
"@red-hat-developer-hub/e2e-test-utils": "1.1.30",
"@types/node": "25.5.2",
"dotenv": "17.4.1",
"eslint": "10.2.0",
"eslint-plugin-check-file": "3.3.1",
"eslint-plugin-playwright": "2.10.1",
"prettier": "3.8.1",
"typescript": "6.0.2",
"typescript-eslint": "8.58.1"
}
}
```
Expand Down
24 changes: 12 additions & 12 deletions docs/overlay/examples/tech-radar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ workspaces/tech-radar/e2e-tests/
"node": ">=22",
"yarn": ">=3"
},
"packageManager": "yarn@3.8.7",
"packageManager": "yarn@4.12.0",
"description": "E2E tests for Tech Radar plugin",
"scripts": {
"test": "playwright test",
Expand All @@ -63,17 +63,17 @@ workspaces/tech-radar/e2e-tests/
"check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
},
"devDependencies": {
"@eslint/js": "^9.39.2",
"@playwright/test": "1.57.0",
"@types/node": "^24.10.1",
"dotenv": "^16.4.7",
"eslint": "^9.39.2",
"eslint-plugin-check-file": "^3.3.1",
"eslint-plugin-playwright": "^2.4.0",
"prettier": "^3.7.4",
"@red-hat-developer-hub/e2e-test-utils": "1.1.22",
"typescript": "^5.9.3",
"typescript-eslint": "^8.50.0"
"@eslint/js": "10.0.1",
"@playwright/test": "1.59.1",
"@red-hat-developer-hub/e2e-test-utils": "1.1.30",
"@types/node": "25.5.2",
"dotenv": "17.4.1",
"eslint": "10.2.0",
"eslint-plugin-check-file": "3.3.1",
"eslint-plugin-playwright": "2.10.1",
"prettier": "3.8.1",
"typescript": "6.0.2",
"typescript-eslint": "8.58.1"
}
}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/overlay/reference/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ These are used by `run-e2e.sh` (the [unified test runner](/overlay/reference/run
|----------|-------------|---------|
| `E2E_TEST_UTILS_PATH` | Absolute path to a local `e2e-test-utils` build | - |
| `E2E_TEST_UTILS_VERSION` | Pin `@red-hat-developer-hub/e2e-test-utils` npm version | `latest` (nightly), empty otherwise |
| `PLAYWRIGHT_VERSION` | Pin `@playwright/test` version | `1.57.0` |
| `PLAYWRIGHT_VERSION` | Pin `@playwright/test` version | `1.59.1` |

::: tip Version Pinning
`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.
Expand Down
10 changes: 5 additions & 5 deletions docs/overlay/reference/run-e2e.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The `run-e2e.sh` script orchestrates E2E test execution across multiple workspac
E2E_TEST_UTILS_PATH=/path/to/rhdh-e2e-test-utils ./run-e2e.sh -w tech-radar

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

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

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

```bash
E2E_TEST_UTILS_VERSION=1.1.24 ./run-e2e.sh -w tech-radar
E2E_TEST_UTILS_VERSION=1.1.30 ./run-e2e.sh -w tech-radar
```

::: info Nightly Default
Expand Down
24 changes: 12 additions & 12 deletions docs/overlay/test-structure/directory-layout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Defines the test package with dependencies and scripts:
"node": ">=22",
"yarn": ">=3"
},
"packageManager": "yarn@3.8.7",
"packageManager": "yarn@4.12.0",
"scripts": {
"test": "playwright test",
"report": "playwright show-report",
Expand All @@ -60,17 +60,17 @@ Defines the test package with dependencies and scripts:
"check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
},
"devDependencies": {
"@eslint/js": "^9.39.2",
"@playwright/test": "1.57.0",
"@types/node": "^24.10.1",
"dotenv": "^16.4.7",
"eslint": "^9.39.2",
"eslint-plugin-check-file": "^3.3.1",
"eslint-plugin-playwright": "^2.4.0",
"prettier": "^3.7.4",
"@red-hat-developer-hub/e2e-test-utils": "1.1.22",
"typescript": "^5.9.3",
"typescript-eslint": "^8.50.0"
"@eslint/js": "10.0.1",
"@playwright/test": "1.59.1",
"@red-hat-developer-hub/e2e-test-utils": "1.1.30",
"@types/node": "25.5.2",
"dotenv": "17.4.1",
"eslint": "10.2.0",
"eslint-plugin-check-file": "3.3.1",
"eslint-plugin-playwright": "2.10.1",
"prettier": "3.8.1",
"typescript": "6.0.2",
"typescript-eslint": "8.58.1"
}
}
```
Expand Down
22 changes: 11 additions & 11 deletions docs/overlay/tutorials/new-workspace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Create `package.json` with the following content:
"node": ">=22",
"yarn": ">=3"
},
"packageManager": "yarn@3.8.7",
"packageManager": "yarn@4.12.0",
"description": "E2E tests for <your-plugin>",
"scripts": {
"test": "playwright test",
Expand All @@ -56,17 +56,17 @@ Create `package.json` with the following content:
"check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
},
"devDependencies": {
"@eslint/js": "^9.39.2",
"@playwright/test": "1.57.0",
"@types/node": "^24.10.1",
"dotenv": "^16.4.7",
"eslint": "^9.39.2",
"eslint-plugin-check-file": "^3.3.1",
"eslint-plugin-playwright": "^2.4.0",
"prettier": "^3.7.4",
"@eslint/js": "10.0.1",
"@playwright/test": "1.59.1",
"@red-hat-developer-hub/e2e-test-utils": "<latest-version>",
"typescript": "^5.9.3",
"typescript-eslint": "^8.50.0"
"@types/node": "25.5.2",
"dotenv": "17.4.1",
"eslint": "10.2.0",
"eslint-plugin-check-file": "3.3.1",
"eslint-plugin-playwright": "2.10.1",
"prettier": "3.8.1",
"typescript": "6.0.2",
"typescript-eslint": "8.58.1"
}
}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@
"engines": {
"node": ">=18"
},
"packageManager": "yarn@3.8.7"
"packageManager": "yarn@4.12.0"
}
Loading
Loading