feat(deployment): make deploy() timeout configurable (#46)

Author: subhashkhileri

docs/.vitepress/config.ts

@@ -33,7 +33,7 @@ export default defineConfig({
       { text: "Examples", link: "/examples/" },
       { text: "Overlay Testing", link: "/overlay/" },
       {
-        text: "v1.1.10",
+        text: "v1.1.12",
         items: [{ text: "Changelog", link: "/changelog" }],
       },
     ],

docs/api/deployment/rhdh-deployment.md

@@ -70,7 +70,7 @@ await rhdh.configure({
 ### `deploy()`
 
 ```typescript
-async deploy(): Promise<void>
+async deploy(options?: { timeout?: number | null }): Promise<void>
 ```
 
 Deploy RHDH to the cluster. This:
@@ -80,8 +80,23 @@ Deploy RHDH to the cluster. This:
 4. Installs RHDH via Helm or Operator
 5. Waits for deployment to be ready
 
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `options.timeout` | `number \| null` | `600_000` | Playwright test timeout (ms) for the deployment. Pass a custom number to override, `0` for no timeout, or `null` to skip and let the consumer control the timeout. |
+
 ```typescript
+// Default (600s timeout)
 await rhdh.deploy();
+
+// Custom timeout (15 minutes)
+await rhdh.deploy({ timeout: 900_000 });
+
+// No timeout (infinite)
+await rhdh.deploy({ timeout: 0 });
+
+// Skip — consumer controls the timeout
+test.setTimeout(900_000);
+await rhdh.deploy({ timeout: null });
 ```
 
 ### `waitUntilReady()`

docs/changelog.md

@@ -2,7 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
-## [1.1.10] - Current
+## [1.1.12] - Current
+
+### Changed
+- **`deploy()` timeout is now configurable**: `deploy()` accepts an optional `{ timeout }` parameter to control the Playwright test timeout during deployment. Defaults to `600_000` (600s). Pass a custom number to override, `0` for no timeout (infinite), or `null` to skip setting the timeout entirely and let the consumer control it.
+
+## [1.1.11]
+
+### Added
+- **`runQuietUnlessFailure()`**: New utility that captures command output silently on success and displays full output on failure for better debugging. Used in Keycloak deployment for `helm repo update` and `helm upgrade --install`.
+
+## [1.1.10]
 
 ### Fixed
 - **`plugins-list.yaml` parsing**: Parse as proper YAML instead of text splitting, correctly handling entries with build flags (e.g., `--embed-package`, `--suppress-native-package`) and YAML comments.

docs/guide/deployment/rhdh-deployment.md

@@ -85,14 +85,31 @@ await deployment.configure({
 });
 ```
 
-### `deploy()`
+### `deploy(options?)`
 
 Deploy RHDH to the cluster:
 
 ```typescript
 await deployment.deploy();
 ```
 
+The `deploy()` method accepts an optional `{ timeout }` parameter to control the Playwright test timeout during deployment. By default, it sets the timeout to 600 seconds (10 minutes).
+
+```typescript
+// Default (600s)
+await rhdh.deploy();
+
+// Custom timeout (15 minutes)
+await rhdh.deploy({ timeout: 900_000 });
+
+// No timeout (infinite)
+await rhdh.deploy({ timeout: 0 });
+
+// Skip — let the consumer control the timeout
+test.setTimeout(900_000);
+await rhdh.deploy({ timeout: null });
+```
+
 This method:
 1. Merges configuration files (common → auth → project)
 2. [Injects plugin metadata](/guide/configuration/config-files#plugin-metadata-injection) into dynamic plugins config

docs/overlay/examples/basic-plugin.md

@@ -56,7 +56,8 @@ workspaces/<plugin>/e2e-tests/
     "lint:fix": "eslint . --fix",
     "prettier:check": "prettier --check .",
     "prettier:fix": "prettier --write .",
-    "check": "tsc --noEmit && yarn lint:check && yarn prettier:check"
+    "tsc:check": "tsc --noEmit",
+    "check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
@@ -67,7 +68,7 @@ workspaces/<plugin>/e2e-tests/
     "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.10",
+    "@red-hat-developer-hub/e2e-test-utils": "1.1.12",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.50.0"
   }

docs/overlay/examples/tech-radar.md

@@ -59,7 +59,8 @@ workspaces/tech-radar/e2e-tests/
     "lint:fix": "eslint . --fix",
     "prettier:check": "prettier --check .",
     "prettier:fix": "prettier --write .",
-    "check": "tsc --noEmit && yarn lint:check && yarn prettier:check"
+    "tsc:check": "tsc --noEmit",
+    "check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
@@ -70,7 +71,7 @@ workspaces/tech-radar/e2e-tests/
     "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.10",
+    "@red-hat-developer-hub/e2e-test-utils": "1.1.12",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.50.0"
   }

docs/overlay/reference/scripts.md

@@ -110,6 +110,14 @@ Auto-format code:
 yarn prettier:fix
 ```
 
+### yarn tsc:check
+
+Run TypeScript type checking:
+
+```bash
+yarn tsc:check
+```
+
 ### yarn check
 
 Run all quality checks:
@@ -120,7 +128,7 @@ yarn check
 
 Equivalent to:
 ```bash
-tsc --noEmit && yarn lint:check && yarn prettier:check
+yarn tsc:check && yarn lint:check && yarn prettier:check
 ```
 
 ## Script Definitions
@@ -138,7 +146,8 @@ Standard `package.json` scripts section:
     "lint:fix": "eslint . --fix",
     "prettier:check": "prettier --check .",
     "prettier:fix": "prettier --write .",
-    "check": "tsc --noEmit && yarn lint:check && yarn prettier:check"
+    "tsc:check": "tsc --noEmit",
+    "check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
   }
 }
 ```

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

@@ -56,7 +56,8 @@ Defines the test package with dependencies and scripts:
     "lint:fix": "eslint . --fix",
     "prettier:check": "prettier --check .",
     "prettier:fix": "prettier --write .",
-    "check": "tsc --noEmit && yarn lint:check && yarn prettier:check"
+    "tsc:check": "tsc --noEmit",
+    "check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
@@ -67,7 +68,7 @@ Defines the test package with dependencies and scripts:
     "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.10",
+    "@red-hat-developer-hub/e2e-test-utils": "1.1.12",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.50.0"
   }

docs/overlay/tutorials/new-workspace.md

@@ -52,7 +52,8 @@ Create `package.json` with the following content:
     "lint:fix": "eslint . --fix",
     "prettier:check": "prettier --check .",
     "prettier:fix": "prettier --write .",
-    "check": "tsc --noEmit && yarn lint:check && yarn prettier:check"
+    "tsc:check": "tsc --noEmit",
+    "check": "yarn tsc:check && yarn lint:check && yarn prettier:check"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",

docs/overlay/tutorials/running-locally.md

@@ -192,7 +192,7 @@ test.beforeEach(async ({ page }) => {
 ### Type Checking
 
 ```bash
-yarn tsc --noEmit
+yarn tsc:check
 ```
 
 ### Linting