Repository navigation
docs: gate cloud-execution page on 3.2.1, fix missing config keys - #34
Merged
Merged
Conversation
Cloud execution does not work in any released version. ConfigurationLoader.
validate() rejects any execution.mode other than local/remote (present at
every tag v2.0.0 through v3.2.0), even though the browserstack/saucelabs
providers behind it are fully implemented. A fix ships in 3.2.1 (not yet
released).
- Added a version-gated caution banner at the top of the page stating cloud
execution requires 3.2.1+. Deliberately does not name any single "broken"
version (broken in every release containing the feature: 2.6.0, 3.0.0,
3.1.0, 3.1.1, 3.2.0) and stays accurate with zero follow-up edits once
3.2.1 ships, since docs.seleniumboot.com is unversioned.
- Fixed all 8 YAML config blocks on the page: each omitted the top-level
browser: and timeouts: keys that ConfigurationLoader.validate() requires,
so copy-pasting any of them failed before even reaching the mode check
("Browser configuration must be specified"). Same defect class as the
README (P1-6a) and guides/parallel.md (PR #33) fixes.
Verified against real Maven Central 3.2.0 + ConfigurationLoader: each
corrected block still fails at the mode check under its documented mode
(browserstack/saucelabs) — that's the bug being documented — but loads
clean (exit path "LOADED OK") when the identical file is loaded with
mode: local, proving the added browser/timeouts keys are correct and
complete.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ConfigurationLoader.validate()rejects anyexecution.modeother thanlocal/remoteat every tag from v2.0.0 through v3.2.0, even though the BrowserStack/Sauce Labs providers behind it are fully implemented. A fix ships in 3.2.1 (not yet released). Added a version-gated:::cautionbanner at the top ofdocs-site/docs/cloud-execution.mdstating cloud execution requires 3.2.1+, without naming any single "broken" version (it's broken in every release containing the feature) so the banner stays accurate with zero follow-up edits once 3.2.1 ships — docs.seleniumboot.com is unversioned.browser:andtimeouts:keys required byConfigurationLoader.validate(), so copy-pasting any of them failed before even reaching the mode check ("Browser configuration must be specified"). Same defect class as the README (P1-6a) andguides/parallel.md(docs: fix invalid config keys and missing timeouts in parallel guide #33) fixes.Verification
Ran each corrected block through the real
ConfigurationLoaderfrom the Maven Central 3.2.0 jar:browserstack/saucelabs): fails only at the mode check —execution.mode must be 'local' or 'remote', got: '...'— which is the bug this page now documents.mode: local: loads clean (LOADED OK), proving the addedbrowser/timeoutskeys are correct and complete.cd docs-site && npm run build— green, no broken links.Test plan
npm run buildindocs-site/succeedsConfigurationLoader(3.2.0 jar)gh issue listchecked) — none linkedCo-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com