docs: adds --posix-exit-codes cli flag for run mode #6284
Conversation
cypress-documentation
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress-documentation
|
| Branch Review |
feat/posix-exit-codes
|
| Run status |
|
| Run duration | 04m 24s |
| Commit |
|
| Committer | Cacie Prins |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
309
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
10.86%
|
|
|---|---|
|
Untested elements
|
2482
|
|
Tested elements
|
3
|
Accessibility
97.21%
|
|
|---|---|
|
Failed rules
|
1 critical
3 serious
4 moderate
0 minor
|
|
Failed elements
|
28
|
This comment was marked as resolved.
This comment was marked as resolved.
This is the default behavior as described in the previous two paragraphs. We are considering whether or not to modify the default behavior to align to posix standards as a breaking change in a later release. |
| #### `cypress run --posix-exit-codes` {#cypress-run-posix-exit-codes} | ||
| Exit with POSIX exit code of 1 when there are test failures or if Cypress could not run. | ||
| ```shell | ||
| cypress run --posix-exit-codes | ||
| ``` | ||
There was a problem hiding this comment.
Maybe cross-link here to the section #Exit-code?
I completely missed this section when I glanced at the change 🤭
There was a problem hiding this comment.
Good idea! Updated here 524b211
| ... | ||
| ``` | ||
| ```text | ||
| ## print exit code on Mac or Linux |
There was a problem hiding this comment.
| ... | |
| ``` | |
| ```text | |
| ## print exit code on Mac or Linux | |
| ... | |
| ## print exit code on Mac or Linux |
Merge into one code block like the other examples above.
|
|
||
| ## 15.4.0 | ||
|
|
||
| _Released 9/30/2025_ |
There was a problem hiding this comment.
| _Released 9/30/2025_ | |
| _Released 10/7/2025_ |
| | `--no-runner-ui` | [Hides the Cypress Runner UI](#cypress-run-no-runner-ui) | | ||
| | `--parallel` | [Run recorded specs in parallel across multiple machines](#cypress-run-parallel) | | ||
| | `--port`,`-p` | [Override default port](#cypress-run-port-lt-port-gt) | | ||
| | `--posix-exit-codes` | [Exit with a POSIX-compliant exit code](#cypress-run-posix-exit-codes) rather than the number of failed tests. | |
There was a problem hiding this comment.
This option needs to be added to the Module API doc: https://deploy-preview-6284--cypress-docs.netlify.app/app/references/module-api
Adds
--posix-exit-codesflag, which disables exiting with the number of tests fail. This is preliminary to adding a custom (but compliant) exit code for terminal cloud API failures during recording or parallel runs.See: cypress-io/cypress#32485