Skip to content
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

Jump to bottom

Update List of Valid Test Configuration Config Values #4252

Merged
merged 8 commits into from
Dec 21, 2021
Merged

Update List of Valid Test Configuration Config Values #4252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f987ab1
update list of writeable config
davidmunechika Dec 3, 2021
3f32e34
update browser config docs
davidmunechika Dec 10, 2021
9cb6fa5
fix spacing
davidmunechika Dec 10, 2021
7ae5375
update Cypress.config docs
davidmunechika Dec 17, 2021
77aad4c
Update wording to be even more specific that the values below are all…
jennifer-shehane Dec 20, 2021
268373f
Don't need to be so specific about why they can't update.
jennifer-shehane Dec 20, 2021
9023081
Merge branch '9.2.0-release' into issue-6407-read-only-config
emilyrohrbough Dec 20, 2021
34adc88
incorrectly resolved Jennifers change
emilyrohrbough Dec 20, 2021
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
8 changes: 4 additions & 4 deletions content/api/cypress-api/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,10 @@ Cypress.config() // => {defaultCommandTimeout: 10000, viewportHeight: 900, ...}

### Not all config values can be changed at all times

Some configuration values are readonly and cannot be changed while running a
test. Anything that's not directly under Cypress's control - like timeouts,
`userAgent`, or environment variables - will be ignored at run-time. Be sure to
review the list of
Some configuration values are readonly and cannot be changed during running a
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

268373f#diff-915c4bed144b351513cdcaa774106a940b56dc71f5a53116990509f9353c46a1R143

test. Anything that is not listed in the
[test configuration options](/guides/references/configuration#Test-Configuration)
cannot be updated at runtime. Be sure to review the list of
[test configuration options](/guides/references/configuration##Test-Configuration).

### Test Configuration vs `Cypress.config()`
Expand Down
18 changes: 11 additions & 7 deletions content/guides/references/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,24 +323,28 @@ We provide two options to override the configuration while your test are
running, `Cypress.config()` and suite-specific or test-specific configuration
overrides.

<Icon name="exclamation-triangle" color="red"></Icon> **Note:** Some
configuration values are readonly and cannot be changed via test configuration.
The following configuration values **can be changed** via per test
configuration:
<Icon name="exclamation-triangle" color="red"></Icon> **Note:** The
configuration values below are all writeable and **can be changed** via per test
configuration. Any other configuration values are readonly and cannot be changed
at run time.

- `animationDistanceThreshold`
- `baseUrl`
- `browser` **note:** filters whether the tests or a suite of tests runs
davidmunechika marked this conversation as resolved.
Show resolved Hide resolved
depending on the current browser
- `blockHosts`
- `defaultCommandTimeout`
- `execTimeout`
- `env` **note:** Provided environment variables will be merged with current
environment variables.
- `execTimeout`
- `experimentalSessionSupport`
- `includeShadowDom`
- `keystrokeDelay`
- `numTestsKeptInMemory`
- `pageLoadTimeout`
- `redirectionLimit`
- `requestTimeout`
- `responseTimeout`
- `retries`
- `screenshotOnRunFailure`
- `scrollBehavior`
- `slowTestThreshold`
- `viewportHeight`
Expand Down