docs: adds --posix-exit-codes cli flag for run mode #6284
Merged
Conversation
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
cypress-documentation
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress-documentation
|
| Branch Review |
feat/posix-exit-codes
|
| Run status |
|
| Run duration | 03m 56s |
| Commit |
|
| Committer | Jennifer Shehane |
| 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.85%
|
|
|---|---|
|
Untested elements
|
2483
|
|
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. |
MikeMcC399
reviewed
Sep 30, 2025
Comment on lines
443
to
450
| #### `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
MikeMcC399
reviewed
Sep 30, 2025
Comment on lines
636
to
640
| ... | ||
| ``` | ||
| ```text | ||
| ## print exit code on Mac or Linux |
There was a problem hiding this comment.
Suggested change
| ... | |
| ``` | |
| ```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.
This was referenced Sep 30, 2025
Closed
AtofStryker
approved these changes
Oct 1, 2025
docs/app/references/changelog.mdx
Outdated
|
|
||
| ## 15.4.0 | ||
|
|
||
| _Released 9/30/2025_ |
There was a problem hiding this comment.
Suggested change
| _Released 9/30/2025_ | |
| _Released 10/7/2025_ |
jennifer-shehane
requested changes
Oct 1, 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
This was referenced Oct 2, 2025
Merged
jennifer-shehane
approved these changes
Oct 6, 2025
AtofStryker
added a commit
that referenced
this pull request
Oct 7, 2025
* remove experimentalStudio flag (#6283) * docs: adds --posix-exit-codes cli flag for run mode (#6284) * adds --posix-exit-codes cli flag for run mode * add history entry * clarify option/description table for --posix-exit-codes * expand docs on posix exit codes * prettify bash block * fix changelog link * formatting * Add posixExitCodes to module API page * changelog * lint fix --------- Co-authored-by: Jennifer Shehane <shehane.jennifer@gmail.com> Co-authored-by: Jennifer Shehane <jennifer@cypress.io> * cy.prompt docs (#6270) * docs: begin writing cy.prompt docs * Iterate on wording * lint * Fix links + improve TOC * Fix some css warnings * update dynamic variable examples * lint fix * update areas based on feedback * lint * Add more examples to prompt docs * lint fix * Add Gherkin examples * lint fix * Add another Gherkin example * lint fix * update some styles to make more space in UI * Update yields of prompt * Update language support * Remove trigger from officially supported 'things to do' * lint * Add not.exist assertions not being supported * expand documented assertion types * Updates for placeholders * update docs * add to TOC * fix loop example. * Update docs/api/commands/prompt.mdx Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * Update docs/api/commands/prompt.mdx Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * Some wording updates * Update docs/api/commands/prompt.mdx Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * lint * fix broken links --------- Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * chore: add 15.4.0 changelog (#6292) * chore: fix headers (#6293) --------- Co-authored-by: Cacie Prins <cacieprins@users.noreply.github.com> Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com>
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.
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