Skip to content

docs: add orchestration.createTimeoutMs configuration [ENG-891]#52

Merged
twk3 merged 2 commits into
mainfrom
feat/create-timeout-doc
Jul 16, 2026
Merged

docs: add orchestration.createTimeoutMs configuration [ENG-891]#52
twk3 merged 2 commits into
mainfrom
feat/create-timeout-doc

Conversation

@twk3

@twk3 twk3 commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Introduced a new configuration option orchestration.createTimeoutMs to specify the timeout for orchestration session creation, with a default of 60 seconds. Updated the pwc-p run documentation to include the --pwc-create-timeout-ms command-line option, allowing users to adjust the timeout for large test suites. This change enhances clarity on managing orchestration timeouts.

Summary by CodeRabbit

  • Documentation
    • Added guidance for configuring the orchestration session creation timeout.
    • Documented the orchestration.createTimeoutMs setting, including default value, environment variable, and version details.
    • Documented the --pwc-create-timeout-ms <milliseconds> option, clarifying it applies only to initial orchestration setup (not per-test timeouts).
    • Included a configuration example for increasing the timeout for larger test suites.

…e option

Introduced a new configuration option `orchestration.createTimeoutMs` to specify the timeout for orchestration session creation, with a default of 60 seconds. Updated the `pwc-p run` documentation to include the `--pwc-create-timeout-ms` command-line option, allowing users to adjust the timeout for large test suites. This change enhances clarity on managing orchestration timeouts.
@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: da74bedd-d1cb-4a36-96d2-4f503774ea3e

📥 Commits

Reviewing files that changed from the base of the PR and between fb4e184 and 3f46672.

📒 Files selected for processing (2)
  • resources/reporters/currents-playwright/configuration.md
  • resources/reporters/currents-playwright/pwc-p-run.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • resources/reporters/currents-playwright/pwc-p-run.md
  • resources/reporters/currents-playwright/configuration.md

📝 Walkthrough

Walkthrough

Documents orchestration.createTimeoutMs and --pwc-create-timeout-ms, including defaults, environment configuration, examples, release information, and scope clarification.

Changes

Orchestration timeout documentation

Layer / File(s) Summary
Timeout configuration and CLI references
resources/reporters/currents-playwright/configuration.md, resources/reporters/currents-playwright/pwc-p-run.md
Documents the orchestration session creation timeout through the configuration property and CLI option, including the default value, environment variable, example usage, release version, and related timeout boundaries.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related issues

  • currents-playwright-changelog issue 1 — Covers the same configurable orchestration session creation timeout across environment, CLI, and configuration surfaces.

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding documentation for orchestration.createTimeoutMs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/create-timeout-doc

Comment @coderabbitai help to get the list of available commands.

@twk3 twk3 changed the title docs: add orchestration.createTimeoutMs configuration docs: add orchestration.createTimeoutMs configuration [ENG-891] Jul 15, 2026
@twk3 twk3 merged commit 1b59a2f into main Jul 16, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant